|
|
|
@@ -469,6 +469,9 @@ |
|
|
|
<li> |
|
|
|
<a href="#ba8983357c" class="toc-h2 toc-link" data-title="仓库详情(新版)">仓库详情(新版)</a> |
|
|
|
</li> |
|
|
|
<li> |
|
|
|
<a href="#46a7ce7681" class="toc-h2 toc-link" data-title="仓库标签列表">仓库标签列表</a> |
|
|
|
</li> |
|
|
|
<li> |
|
|
|
<a href="#af9709123a" class="toc-h2 toc-link" data-title="编辑仓库信息">编辑仓库信息</a> |
|
|
|
</li> |
|
|
|
@@ -499,6 +502,12 @@ |
|
|
|
<li> |
|
|
|
<a href="#fcc64a694b" class="toc-h2 toc-link" data-title="获取仓库代码子目录或者文件">获取仓库代码子目录或者文件</a> |
|
|
|
</li> |
|
|
|
<li> |
|
|
|
<a href="#readme" class="toc-h2 toc-link" data-title="获取仓库README文件">获取仓库README文件</a> |
|
|
|
</li> |
|
|
|
<li> |
|
|
|
<a href="#28d27a81d5" class="toc-h2 toc-link" data-title="获取仓库贡献者">获取仓库贡献者</a> |
|
|
|
</li> |
|
|
|
<li> |
|
|
|
<a href="#webhooks" class="toc-h2 toc-link" data-title="获取仓库webhooks列表">获取仓库webhooks列表</a> |
|
|
|
</li> |
|
|
|
@@ -6179,6 +6188,211 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat |
|
|
|
</span><span class="nl">"Shell"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.1%"</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='46a7ce7681'>仓库标签列表</h2> |
|
|
|
<p>仓库标签列表</p> |
|
|
|
|
|
|
|
<blockquote> |
|
|
|
<p>示例:</p> |
|
|
|
</blockquote> |
|
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET http://localhost:3000/api/yystopf/csfjkkj/tags.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/yystopf/csfjkkj/tags.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-4'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/tags.json</code></p> |
|
|
|
<h3 id='2eb6f47757-4'>请求参数:</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>page</td> |
|
|
|
<td>否</td> |
|
|
|
<td>1</td> |
|
|
|
<td>integer</td> |
|
|
|
<td>页码</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>limit</td> |
|
|
|
<td>否</td> |
|
|
|
<td>20</td> |
|
|
|
<td>integer</td> |
|
|
|
<td>每页个数</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-4'>返回字段说明:</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>name</td> |
|
|
|
<td>string</td> |
|
|
|
<td>标签名称</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>zipball_url</td> |
|
|
|
<td>string</td> |
|
|
|
<td>标签zip包下载地址</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>tarball_url</td> |
|
|
|
<td>string</td> |
|
|
|
<td>标签tar包下载地址</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>tagger</td> |
|
|
|
<td>object</td> |
|
|
|
<td>打标签的人</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>time_ago</td> |
|
|
|
<td>string</td> |
|
|
|
<td>打标签的时间</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>created_at_unix</td> |
|
|
|
<td>string</td> |
|
|
|
<td>打标签的时间戳</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>message</td> |
|
|
|
<td>string</td> |
|
|
|
<td>标签信息</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit</td> |
|
|
|
<td>object</td> |
|
|
|
<td>标签最后一个commit</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit.sha</td> |
|
|
|
<td>string</td> |
|
|
|
<td>commit的id</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit.message</td> |
|
|
|
<td>string</td> |
|
|
|
<td>commit的提交信息</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit.time_ago</td> |
|
|
|
<td>string</td> |
|
|
|
<td>commit的提交时间</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit.created_at_unix</td> |
|
|
|
<td>string</td> |
|
|
|
<td>commit的提交时间戳</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit.committer</td> |
|
|
|
<td>object</td> |
|
|
|
<td>commit的提交者</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>commit.author</td> |
|
|
|
<td>object</td> |
|
|
|
<td>commit的作者</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="p">{</span><span class="w"> |
|
|
|
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v2.0.0"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c7d0873ee41796d1a0e193063095ccf539a9bf31"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"zipball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3000/api/yystopf/csfjkkj/archive/v2.0.0.zip"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"tarball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3000/api/yystopf/csfjkkj/archive/v2.0.0.tar.gz"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"tagger"</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="mi">4</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">"testforge1"</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">"testforge1"</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/T/19_237_174/120.png"</span><span class="w"> |
|
|
|
</span><span class="p">},</span><span class="w"> |
|
|
|
</span><span class="nl">"time_ago"</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">"created_at_unix"</span><span class="p">:</span><span class="w"> </span><span class="mi">1632376903</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">"jdfkls"</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">"08fe383f1e5ebe2e2a384a8ea3ee890a758c7cd7"</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">"add</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"time_ago"</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">"created_at_unix"</span><span class="p">:</span><span class="w"> </span><span class="mi">1632376186</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="mi">4</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">"testforge1"</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">"testforge1"</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/T/19_237_174/120.png"</span><span class="w"> |
|
|
|
</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="mi">4</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">"testforge1"</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">"testforge1"</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/T/19_237_174/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="p">},</span><span class="w"> |
|
|
|
</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">"v1.0.0"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"12168ad39c3ef201a445a2db181a3e43d50e40dd"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"zipball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3000/api/yystopf/csfjkkj/archive/v1.0.0.zip"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"tarball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3000/api/yystopf/csfjkkj/archive/v1.0.0.tar.gz"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"tagger"</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">"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">"time_ago"</span><span class="p">:</span><span class="w"> </span><span class="s2">"10天前"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"created_at_unix"</span><span class="p">:</span><span class="w"> </span><span class="mi">1631588042</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">"dfks"</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">"5291b5e45a377c1f7710cc6647259887ed7aaccf"</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">"ADD file via upload</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"time_ago"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21天前"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"created_at_unix"</span><span class="p">:</span><span class="w"> </span><span class="mi">1630648417</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">"yystopf"</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">"yystopf"</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/Y/241_125_89/120.png"</span><span class="w"> |
|
|
|
</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">"yystopf"</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">"yystopf"</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/Y/241_125_89/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="p">}</span><span class="w"> |
|
|
|
</span><span class="p">]</span><span class="w"> |
|
|
|
</span></code></pre></div><h2 id='af9709123a'>编辑仓库信息</h2> |
|
|
|
<p>编辑仓库信息</p> |
|
|
|
|
|
|
|
@@ -6187,9 +6401,9 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat |
|
|
|
</blockquote> |
|
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET http://localhost:3000/api/jasder/jasder_test/edit.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/jasder/jasder_test/edit.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-4'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-5'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/edit.json</code></p> |
|
|
|
<h3 id='2eb6f47757-4'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-5'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6214,7 +6428,7 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat |
|
|
|
<td>项目标识identifier</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-4'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-5'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6291,9 +6505,9 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat |
|
|
|
<span class="nt">-d</span> <span class="s2">"private=true"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/jasder/jasder_test.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/jasder/jasder_test.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-5'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-6'>HTTP 请求</h3> |
|
|
|
<p><code>PATCH /api/:owner/:repo</code></p> |
|
|
|
<h3 id='2eb6f47757-5'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-6'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6353,7 +6567,7 @@ http://localhost:3000/api/jasder/jasder_test.json |
|
|
|
<td>项目是否私有, true:为私有,false: 公开,默认为公开</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-5'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-6'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6418,9 +6632,9 @@ http://localhost:3000/api/jasder/jasder_test.json |
|
|
|
</blockquote> |
|
|
|
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE http://localhost:3000/api/jasder/jasder_test.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/jasder/jasder_test.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>PATCH /api/:owner/:repo</code></p> |
|
|
|
<h3 id='2eb6f47757-6'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-7'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6445,7 +6659,7 @@ http://localhost:3000/api/jasder/jasder_test.json |
|
|
|
<td>项目标识identifier</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-6'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-7'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6486,9 +6700,9 @@ http://localhost:3000/api/jasder/jasder_test.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"user_id=12"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/jasder/jasder_test/collaborators.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/jasder/jasder_test/collaborators.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>POST /api/:owner/:repo/collaborators.json</code></p> |
|
|
|
<h3 id='2eb6f47757-7'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-8'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6520,7 +6734,7 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json |
|
|
|
<td>用户id</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-7'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-8'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6561,9 +6775,9 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"user_id=12"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/jasder/jasder_test/collaborators.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/jasder/jasder_test/collaborators.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>DELETE /api/:owner/:repo/collaborators.json</code></p> |
|
|
|
<h3 id='2eb6f47757-8'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-9'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6595,7 +6809,7 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json |
|
|
|
<td>用户id</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-8'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-9'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6637,9 +6851,9 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"role=Developer"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/jasder/jasder_test/change_role.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">PUT /api/jasder/jasder_test/change_role.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-9'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-10'>HTTP 请求</h3> |
|
|
|
<p><code>PUT /api/:owner/:repo/change_role.json</code></p> |
|
|
|
<h3 id='2eb6f47757-9'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-10'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6678,7 +6892,7 @@ http://localhost:3000/api/jasder/jasder_test/change_role.json |
|
|
|
<td>取值范围:"Manager", "Developer", "Reporter";分别为项目管理人员(拥有所有操作权限)、项目开发人员(只拥有读写权限)、项目报告人员(只拥有读权限)</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-9'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-10'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6720,9 +6934,9 @@ http://localhost:3000/api/jasder/jasder_test/change_role.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"limit=5"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/jasder/jasder_test/collaborators.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/jasder/jasder_test/collaborators.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-10'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-11'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/collaborators.json</code></p> |
|
|
|
<h3 id='2eb6f47757-10'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-11'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6761,7 +6975,7 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json |
|
|
|
<td>每页多少条数据,默认15条</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-10'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-11'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6849,9 +7063,9 @@ http://localhost:3000/api/jasder/jasder_test/collaborators.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"ref=develop"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/yystopf/ceshi/files.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/yystopf/ceshi/files.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-11'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-12'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/files</code></p> |
|
|
|
<h3 id='2eb6f47757-11'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-12'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6890,7 +7104,7 @@ http://localhost:3000/api/yystopf/ceshi/files.json |
|
|
|
<td>分支名,默认为仓库默认分支</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-11'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-12'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -6972,9 +7186,9 @@ http://localhost:3000/api/yystopf/ceshi/files.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"ref=develop"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000//api/jasder/jasder_test/entries.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/jasder/jasder_test/entries.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-12'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-13'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/entries.json</code></p> |
|
|
|
<h3 id='2eb6f47757-12'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-13'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7006,7 +7220,7 @@ http://localhost:3000//api/jasder/jasder_test/entries.json |
|
|
|
<td>分支名称、tag名称或是提交记录id,默认为master分支</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-12'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-13'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7120,9 +7334,9 @@ http://localhost:3000//api/jasder/jasder_test/entries.json |
|
|
|
<span class="nt">-d</span> <span class="s2">"filepath=file"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000//api/jasder/jasder_test/sub_entries.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/jasder/jasder_test/sub_entries.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-13'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-14'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/sub_entries.json</code></p> |
|
|
|
<h3 id='2eb6f47757-13'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-14'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7161,7 +7375,7 @@ http://localhost:3000//api/jasder/jasder_test/sub_entries.json |
|
|
|
<td>分支名称、tag名称或是提交记录id,默认为master分支</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-13'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-14'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7247,6 +7461,237 @@ http://localhost:3000//api/jasder/jasder_test/sub_entries.json |
|
|
|
<aside class="success"> |
|
|
|
Success Data. |
|
|
|
</aside> |
|
|
|
<h2 id='readme'>获取仓库README文件</h2> |
|
|
|
<p>获取仓库README文件</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">"ref=master"</span> <span class="se">\</span> |
|
|
|
<span class="nt">-d</span> <span class="s2">"filepath=lib"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/yystopf/csfjkkj/readme.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/yystopf/csfjkkj/readme.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-15'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/readme.json</code></p> |
|
|
|
<h3 id='2eb6f47757-15'>请求参数:</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>ref</td> |
|
|
|
<td>否</td> |
|
|
|
<td></td> |
|
|
|
<td>string</td> |
|
|
|
<td>分支名称、tag名称或是提交记录id,默认为默认分支</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>filepath</td> |
|
|
|
<td>否</td> |
|
|
|
<td></td> |
|
|
|
<td>string</td> |
|
|
|
<td>子目录名称,默认为空</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-15'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
<th>类型</th> |
|
|
|
<th>字段说明</th> |
|
|
|
</tr> |
|
|
|
</thead><tbody> |
|
|
|
<tr> |
|
|
|
<td>type</td> |
|
|
|
<td>string</td> |
|
|
|
<td>文件类型, file:文件,dir:文件目录</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>encoding</td> |
|
|
|
<td>string</td> |
|
|
|
<td>编码</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>size</td> |
|
|
|
<td>int</td> |
|
|
|
<td>文件夹或文件大小 单位B</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>name</td> |
|
|
|
<td>string</td> |
|
|
|
<td>文件夹或文件名称</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>path</td> |
|
|
|
<td>string</td> |
|
|
|
<td>文件夹或文件相对路径</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>content</td> |
|
|
|
<td>string</td> |
|
|
|
<td>文件内容</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>sha</td> |
|
|
|
<td>string</td> |
|
|
|
<td>文件commitid</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"file"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"encoding"</span><span class="p">:</span><span class="w"> </span><span class="s2">"base64"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"size"</span><span class="p">:</span><span class="w"> </span><span class="mi">24</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">"README.md"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lib/README.md"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ZGZhc2RhZGpmIGRrZnNsCgpzZGZkZnMK"</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">"860962cd21c60b1a9e07d723080c87c32c18d44a"</span><span class="w"> |
|
|
|
</span><span class="p">}</span><span class="w"> |
|
|
|
</span></code></pre></div> |
|
|
|
<aside class="success"> |
|
|
|
Success Data. |
|
|
|
</aside> |
|
|
|
<h2 id='28d27a81d5'>获取仓库贡献者</h2> |
|
|
|
<p>获取仓库贡献者</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">"ref=master"</span> <span class="se">\</span> |
|
|
|
<span class="nt">-d</span> <span class="s2">"filepath=lib"</span> <span class="se">\</span> |
|
|
|
http://localhost:3000/api/yystopf/csfjkkj/contributors.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/yystopf/csfjkkj/contributors.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-16'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/contributors.json</code></p> |
|
|
|
<h3 id='2eb6f47757-16'>请求参数:</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>ref</td> |
|
|
|
<td>否</td> |
|
|
|
<td></td> |
|
|
|
<td>string</td> |
|
|
|
<td>分支名称、tag名称或是提交记录id,默认为整个仓库</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>filepath</td> |
|
|
|
<td>否</td> |
|
|
|
<td></td> |
|
|
|
<td>string</td> |
|
|
|
<td>子目录名称,默认为空</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-16'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
<th>类型</th> |
|
|
|
<th>字段说明</th> |
|
|
|
</tr> |
|
|
|
</thead><tbody> |
|
|
|
<tr> |
|
|
|
<td>total_count</td> |
|
|
|
<td>integer</td> |
|
|
|
<td>贡献者数量</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>contributions</td> |
|
|
|
<td>integer</td> |
|
|
|
<td>贡献数量</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>login</td> |
|
|
|
<td>string</td> |
|
|
|
<td>用户登录名</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>type</td> |
|
|
|
<td>string</td> |
|
|
|
<td>用户类型</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>name</td> |
|
|
|
<td>string</td> |
|
|
|
<td>用户昵称</td> |
|
|
|
</tr> |
|
|
|
<tr> |
|
|
|
<td>image_url</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">"contributors"</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">"contributions"</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">"login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"testforge2"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"User"</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">"testforge2"</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/T/236_177_85/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">"contributions"</span><span class="p">:</span><span class="w"> </span><span class="mi">79</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">"yystopf"</span><span class="p">,</span><span class="w"> |
|
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"User"</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">"yystopf"</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/Y/241_125_89/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">"total_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w"> |
|
|
|
</span><span class="p">}</span><span class="w"> |
|
|
|
</span></code></pre></div> |
|
|
|
<aside class="success"> |
|
|
|
Success Data. |
|
|
|
</aside> |
|
|
|
<h2 id='webhooks'>获取仓库webhooks列表</h2> |
|
|
|
<p>获取仓库webhooks列表</p> |
|
|
|
|
|
|
|
@@ -7256,9 +7701,9 @@ http://localhost:3000//api/jasder/jasder_test/sub_entries.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/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/yystopf/ceshi/webhooks.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-14'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-17'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/webhooks.json</code></p> |
|
|
|
<h3 id='2eb6f47757-14'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-17'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7283,7 +7728,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks.json |
|
|
|
<td>项目标识identifier</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-14'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-17'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7385,9 +7830,9 @@ http://localhost:3000/api/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/yystopf/ceshi/webhooks/3/edit.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/yystopf/ceshi/webhooks/3/edit.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-15'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-18'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/webhooks/:id/edit.json</code></p> |
|
|
|
<h3 id='2eb6f47757-15'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-18'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7419,7 +7864,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/edit.json |
|
|
|
<td>webhook ID</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-15'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-18'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7620,9 +8065,9 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/edit.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/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/yystopf/ceshi/webhooks.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-16'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-19'>HTTP 请求</h3> |
|
|
|
<p><code>POST /api/:owner/:repo/webhooks.json</code></p> |
|
|
|
<h3 id='2eb6f47757-16'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-19'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7806,7 +8251,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks.json |
|
|
|
</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-16'>返回字段说明:</h3> |
|
|
|
</span></code></pre></div><h3 id='7447e4874e-19'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -7878,9 +8323,9 @@ http://localhost:3000/api/yystopf/ceshi/webhooks.json |
|
|
|
<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/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/yystopf/ceshi/webhooks/7.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-17'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-20'>HTTP 请求</h3> |
|
|
|
<p><code>PATCH /api/:owner/:repo/webhooks/:id.json</code></p> |
|
|
|
<h3 id='2eb6f47757-17'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-20'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -8071,7 +8516,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/7.json |
|
|
|
</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-17'>返回字段说明:</h3> |
|
|
|
</span></code></pre></div><h3 id='7447e4874e-20'>返回字段说明:</h3> |
|
|
|
<blockquote> |
|
|
|
<p>返回的JSON示例:</p> |
|
|
|
</blockquote> |
|
|
|
@@ -8092,9 +8537,9 @@ http://localhost:3000/api/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/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/yystopf/ceshi/webhooks/7.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-18'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-21'>HTTP 请求</h3> |
|
|
|
<p><code>DELETE /api/:owner/:repo/webhooks/:id.json</code></p> |
|
|
|
<h3 id='2eb6f47757-18'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-21'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -8126,7 +8571,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/7.json |
|
|
|
<td>webhook id</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-18'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-21'>返回字段说明:</h3> |
|
|
|
<blockquote> |
|
|
|
<p>返回的JSON示例:</p> |
|
|
|
</blockquote> |
|
|
|
@@ -8147,9 +8592,9 @@ http://localhost:3000/api/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/yystopf/ceshi/webhooks/3/tasks.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/yystopf/ceshi/webhooks/3/tasks.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-19'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-22'>HTTP 请求</h3> |
|
|
|
<p><code>GET /api/:owner/:repo/webhooks/:id/tasks.json</code></p> |
|
|
|
<h3 id='2eb6f47757-19'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-22'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -8181,7 +8626,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/tasks.json |
|
|
|
<td>webhook ID</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-19'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-22'>返回字段说明:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -8418,9 +8863,9 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/tasks.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/yystopf/ceshi/webhooks/3/test.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/webhooks/3/test.json</span><span class="dl">'</span><span class="p">)</span> |
|
|
|
</code></pre></div><h3 id='http-20'>HTTP 请求</h3> |
|
|
|
</code></pre></div><h3 id='http-23'>HTTP 请求</h3> |
|
|
|
<p><code>POST /api/:owner/:repo/webhooks/:id/test.json</code></p> |
|
|
|
<h3 id='2eb6f47757-20'>请求参数:</h3> |
|
|
|
<h3 id='2eb6f47757-23'>请求参数:</h3> |
|
|
|
<table><thead> |
|
|
|
<tr> |
|
|
|
<th>参数</th> |
|
|
|
@@ -8452,7 +8897,7 @@ http://localhost:3000/api/yystopf/ceshi/webhooks/3/test.json |
|
|
|
<td>webhook ID</td> |
|
|
|
</tr> |
|
|
|
</tbody></table> |
|
|
|
<h3 id='7447e4874e-20'>返回字段说明:</h3> |
|
|
|
<h3 id='7447e4874e-23'>返回字段说明:</h3> |
|
|
|
<blockquote> |
|
|
|
<p>返回的JSON示例:</p> |
|
|
|
</blockquote> |
|
|
|
|