forked from Gitlink/forgeplus
10316 lines
511 KiB
HTML
10316 lines
511 KiB
HTML
|
||
<!doctype html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
||
<title>Trustie API Reference</title>
|
||
|
||
<style media="screen">
|
||
.highlight table td { padding: 5px; }
|
||
.highlight table pre { margin: 0; }
|
||
.highlight .gh {
|
||
color: #999999;
|
||
}
|
||
.highlight .sr {
|
||
color: #f6aa11;
|
||
}
|
||
.highlight .go {
|
||
color: #888888;
|
||
}
|
||
.highlight .gp {
|
||
color: #555555;
|
||
}
|
||
.highlight .gs {
|
||
}
|
||
.highlight .gu {
|
||
color: #aaaaaa;
|
||
}
|
||
.highlight .nb {
|
||
color: #f6aa11;
|
||
}
|
||
.highlight .cm {
|
||
color: #75715e;
|
||
}
|
||
.highlight .cp {
|
||
color: #75715e;
|
||
}
|
||
.highlight .c1 {
|
||
color: #75715e;
|
||
}
|
||
.highlight .cs {
|
||
color: #75715e;
|
||
}
|
||
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
|
||
color: #75715e;
|
||
}
|
||
.highlight .err {
|
||
color: #960050;
|
||
}
|
||
.highlight .gr {
|
||
color: #960050;
|
||
}
|
||
.highlight .gt {
|
||
color: #960050;
|
||
}
|
||
.highlight .gd {
|
||
color: #49483e;
|
||
}
|
||
.highlight .gi {
|
||
color: #49483e;
|
||
}
|
||
.highlight .ge {
|
||
color: #49483e;
|
||
}
|
||
.highlight .kc {
|
||
color: #66d9ef;
|
||
}
|
||
.highlight .kd {
|
||
color: #66d9ef;
|
||
}
|
||
.highlight .kr {
|
||
color: #66d9ef;
|
||
}
|
||
.highlight .no {
|
||
color: #66d9ef;
|
||
}
|
||
.highlight .kt {
|
||
color: #66d9ef;
|
||
}
|
||
.highlight .mf {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .mh {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .il {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .mi {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .mo {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .m, .highlight .mb, .highlight .mx {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .sc {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .se {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .ss {
|
||
color: #ae81ff;
|
||
}
|
||
.highlight .sd {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .s2 {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .sb {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .sh {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .si {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .sx {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .s1 {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .s, .highlight .sa, .highlight .dl {
|
||
color: #e6db74;
|
||
}
|
||
.highlight .na {
|
||
color: #a6e22e;
|
||
}
|
||
.highlight .nc {
|
||
color: #a6e22e;
|
||
}
|
||
.highlight .nd {
|
||
color: #a6e22e;
|
||
}
|
||
.highlight .ne {
|
||
color: #a6e22e;
|
||
}
|
||
.highlight .nf, .highlight .fm {
|
||
color: #a6e22e;
|
||
}
|
||
.highlight .vc {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .nn {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .ni {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .bp {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .vg {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .vi {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .nv, .highlight .vm {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .w {
|
||
color: #ffffff;
|
||
}
|
||
.highlight {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .n, .highlight .py, .highlight .nx {
|
||
color: #ffffff;
|
||
}
|
||
.highlight .nl {
|
||
color: #f92672;
|
||
}
|
||
.highlight .ow {
|
||
color: #f92672;
|
||
}
|
||
.highlight .nt {
|
||
color: #f92672;
|
||
}
|
||
.highlight .k, .highlight .kv {
|
||
color: #f92672;
|
||
}
|
||
.highlight .kn {
|
||
color: #f92672;
|
||
}
|
||
.highlight .kp {
|
||
color: #f92672;
|
||
}
|
||
.highlight .o {
|
||
color: #f92672;
|
||
}
|
||
</style>
|
||
<style media="print">
|
||
* {
|
||
-webkit-transition:none!important;
|
||
transition:none!important;
|
||
}
|
||
.highlight table td { padding: 5px; }
|
||
.highlight table pre { margin: 0; }
|
||
.highlight, .highlight .w {
|
||
color: #586e75;
|
||
}
|
||
.highlight .err {
|
||
color: #002b36;
|
||
background-color: #dc322f;
|
||
}
|
||
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {
|
||
color: #657b83;
|
||
}
|
||
.highlight .cp {
|
||
color: #b58900;
|
||
}
|
||
.highlight .nt {
|
||
color: #b58900;
|
||
}
|
||
.highlight .o, .highlight .ow {
|
||
color: #93a1a1;
|
||
}
|
||
.highlight .p, .highlight .pi {
|
||
color: #93a1a1;
|
||
}
|
||
.highlight .gi {
|
||
color: #859900;
|
||
}
|
||
.highlight .gd {
|
||
color: #dc322f;
|
||
}
|
||
.highlight .gh {
|
||
color: #268bd2;
|
||
background-color: #002b36;
|
||
font-weight: bold;
|
||
}
|
||
.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
|
||
color: #6c71c4;
|
||
}
|
||
.highlight .kc {
|
||
color: #cb4b16;
|
||
}
|
||
.highlight .kt {
|
||
color: #cb4b16;
|
||
}
|
||
.highlight .kd {
|
||
color: #cb4b16;
|
||
}
|
||
.highlight .s, .highlight .sa, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
|
||
color: #859900;
|
||
}
|
||
.highlight .sr {
|
||
color: #2aa198;
|
||
}
|
||
.highlight .si {
|
||
color: #d33682;
|
||
}
|
||
.highlight .se {
|
||
color: #d33682;
|
||
}
|
||
.highlight .nn {
|
||
color: #b58900;
|
||
}
|
||
.highlight .nc {
|
||
color: #b58900;
|
||
}
|
||
.highlight .no {
|
||
color: #b58900;
|
||
}
|
||
.highlight .na {
|
||
color: #268bd2;
|
||
}
|
||
.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
|
||
color: #859900;
|
||
}
|
||
.highlight .ss {
|
||
color: #859900;
|
||
}
|
||
</style>
|
||
<link href="stylesheets/screen-69a70330.css" rel="stylesheet" media="screen" />
|
||
<link href="stylesheets/print-953e3353.css" rel="stylesheet" media="print" />
|
||
<script src="javascripts/all-e033bdd3.js"></script>
|
||
|
||
<script>
|
||
$(function() { setupCodeCopy(); });
|
||
</script>
|
||
</head>
|
||
|
||
<body class="api" data-languages="["shell","javascript"]">
|
||
<a href="#" id="nav-button">
|
||
<span>
|
||
NAV
|
||
<img src="images/navbar-cad8cdcb.png" alt="" />
|
||
</span>
|
||
</a>
|
||
<div class="toc-wrapper">
|
||
<img src="images/logo-8bc02cd4.png" class="logo " alt="" />
|
||
<div class="lang-selector">
|
||
<a href="#" data-language-name="shell">Shell</a>
|
||
<a href="#" data-language-name="javascript">JavaScript</a>
|
||
</div>
|
||
<div class="search">
|
||
<input type="text" class="search" id="input-search" placeholder="Search">
|
||
</div>
|
||
<ul class="search-results"></ul>
|
||
<ul id="toc" class="toc-list-h1">
|
||
<li>
|
||
<a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a>
|
||
</li>
|
||
<li>
|
||
<a href="#licenses" class="toc-h1 toc-link" data-title="Licenses">Licenses</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#get-all-licenses" class="toc-h2 toc-link" data-title="Get All Licenses">Get All Licenses</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#gitignores" class="toc-h1 toc-link" data-title="Gitignores">Gitignores</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#gitignore" class="toc-h2 toc-link" data-title="gitignore模板列表">gitignore模板列表</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#publickeys" class="toc-h1 toc-link" data-title="PublicKeys">PublicKeys</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#public_keys" class="toc-h2 toc-link" data-title="public_keys列表">public_keys列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#public_key" class="toc-h2 toc-link" data-title="创建public_key">创建public_key</a>
|
||
</li>
|
||
<li>
|
||
<a href="#public_key-2" class="toc-h2 toc-link" data-title="删除public_key">删除public_key</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#users" class="toc-h1 toc-link" data-title="Users">Users</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#1ae74893b1" class="toc-h2 toc-link" data-title="获取当前登陆用户信息">获取当前登陆用户信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#5b752913ae" class="toc-h2 toc-link" data-title="用户消息列表">用户消息列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#6087e717ed" class="toc-h2 toc-link" data-title="用户阅读系统通知">用户阅读系统通知</a>
|
||
</li>
|
||
<li>
|
||
<a href="#94306b2fc3" class="toc-h2 toc-link" data-title="发送消息">发送消息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#d69a1523bb" class="toc-h2 toc-link" data-title="阅读消息">阅读消息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#c5dc622a5a" class="toc-h2 toc-link" data-title="删除消息">删除消息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#c6da6881ac" class="toc-h2 toc-link" data-title="更改用户信息">更改用户信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#8469c9a565" class="toc-h2 toc-link" data-title="获取平台消息设置配置信息">获取平台消息设置配置信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#e731847818" class="toc-h2 toc-link" data-title="获取用户消息设置配置信息">获取用户消息设置配置信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#47e7414364" class="toc-h2 toc-link" data-title="重新设置用户消息设置配置信息">重新设置用户消息设置配置信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#16a4666845" class="toc-h2 toc-link" data-title="获取用户星标项目">获取用户星标项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#3064477f38" class="toc-h2 toc-link" data-title="用户添加星标项目">用户添加星标项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#3f31dec5ae" class="toc-h2 toc-link" data-title="星标项目展示排序">星标项目展示排序</a>
|
||
</li>
|
||
<li>
|
||
<a href="#4a39412749" class="toc-h2 toc-link" data-title="用户近期活动统计">用户近期活动统计</a>
|
||
</li>
|
||
<li>
|
||
<a href="#04cb758654" class="toc-h2 toc-link" data-title="获取用户贡献度">获取用户贡献度</a>
|
||
</li>
|
||
<li>
|
||
<a href="#7931751284" class="toc-h2 toc-link" data-title="获取用户动态">获取用户动态</a>
|
||
</li>
|
||
<li>
|
||
<a href="#02488a20d5" class="toc-h2 toc-link" data-title="用户开发能力">用户开发能力</a>
|
||
</li>
|
||
<li>
|
||
<a href="#aa848a4fa0" class="toc-h2 toc-link" data-title="用户角色定位">用户角色定位</a>
|
||
</li>
|
||
<li>
|
||
<a href="#ae21e852b6" class="toc-h2 toc-link" data-title="用户专业定位">用户专业定位</a>
|
||
</li>
|
||
<li>
|
||
<a href="#fcaf20021b" class="toc-h2 toc-link" data-title="待办事项-用户通知信息">待办事项-用户通知信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#dd01263b80" class="toc-h2 toc-link" data-title="待办事项-接受仓库">待办事项-接受仓库</a>
|
||
</li>
|
||
<li>
|
||
<a href="#db5a40a55d" class="toc-h2 toc-link" data-title="用户接受迁移">用户接受迁移</a>
|
||
</li>
|
||
<li>
|
||
<a href="#5e6ed41015" class="toc-h2 toc-link" data-title="用户拒绝迁移">用户拒绝迁移</a>
|
||
</li>
|
||
<li>
|
||
<a href="#ba97e431b8" class="toc-h2 toc-link" data-title="待办事项-项目申请">待办事项-项目申请</a>
|
||
</li>
|
||
<li>
|
||
<a href="#e8ec937c34" class="toc-h2 toc-link" data-title="用户接受申请">用户接受申请</a>
|
||
</li>
|
||
<li>
|
||
<a href="#f2ee84ecf7" class="toc-h2 toc-link" data-title="用户拒绝申请">用户拒绝申请</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#projects" class="toc-h1 toc-link" data-title="Projects">Projects</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#ac55469b06" class="toc-h2 toc-link" data-title="申请加入项目">申请加入项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#bfdfb34952" class="toc-h2 toc-link" data-title="获取项目列表">获取项目列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#43137706c6" class="toc-h2 toc-link" data-title="推荐项目">推荐项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#42ee1e960d" class="toc-h2 toc-link" data-title="项目导航">项目导航</a>
|
||
</li>
|
||
<li>
|
||
<a href="#144f9deebe" class="toc-h2 toc-link" data-title="项目主页">项目主页</a>
|
||
</li>
|
||
<li>
|
||
<a href="#d088903907" class="toc-h2 toc-link" data-title="项目模块信息">项目模块信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#ed3c54441c" class="toc-h2 toc-link" data-title="更改项目模块展示">更改项目模块展示</a>
|
||
</li>
|
||
<li>
|
||
<a href="#80f5dfd187" class="toc-h2 toc-link" data-title="创建项目">创建项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#2396d2124e" class="toc-h2 toc-link" data-title="创建镜像项目">创建镜像项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#1940f9da56" class="toc-h2 toc-link" data-title="同步镜像">同步镜像</a>
|
||
</li>
|
||
<li>
|
||
<a href="#fork" class="toc-h2 toc-link" data-title="Fork项目">Fork项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#da9d632a06" class="toc-h2 toc-link" data-title="用户管理的组织列表">用户管理的组织列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#ac41ac8cdc" class="toc-h2 toc-link" data-title="迁移项目">迁移项目</a>
|
||
</li>
|
||
<li>
|
||
<a href="#4f8579f6bd" class="toc-h2 toc-link" data-title="取消迁移项目">取消迁移项目</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#repositories" class="toc-h1 toc-link" data-title="Repositories">Repositories</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#0a366f0c25" class="toc-h2 toc-link" data-title="仓库详情">仓库详情</a>
|
||
</li>
|
||
<li>
|
||
<a href="#32bf9fcdcf" class="toc-h2 toc-link" data-title="仓库详情(简版)">仓库详情(简版)</a>
|
||
</li>
|
||
<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>
|
||
<li>
|
||
<a href="#3c8c437c47" class="toc-h2 toc-link" data-title="修改仓库信息">修改仓库信息</a>
|
||
</li>
|
||
<li>
|
||
<a href="#34ae800a2c" class="toc-h2 toc-link" data-title="删除仓库">删除仓库</a>
|
||
</li>
|
||
<li>
|
||
<a href="#8801e8fd87" class="toc-h2 toc-link" data-title="添加仓库成员">添加仓库成员</a>
|
||
</li>
|
||
<li>
|
||
<a href="#c25af9423c" class="toc-h2 toc-link" data-title="删除仓库成员">删除仓库成员</a>
|
||
</li>
|
||
<li>
|
||
<a href="#d4fbcddc09" class="toc-h2 toc-link" data-title="更改仓库成员角色(权限)">更改仓库成员角色(权限)</a>
|
||
</li>
|
||
<li>
|
||
<a href="#1091eafea0" class="toc-h2 toc-link" data-title="获取仓库成员列表">获取仓库成员列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#59943eacca" class="toc-h2 toc-link" data-title="获取仓库所有文件">获取仓库所有文件</a>
|
||
</li>
|
||
<li>
|
||
<a href="#0c98b4c01b" class="toc-h2 toc-link" data-title="获取仓库代码目录">获取仓库代码目录</a>
|
||
</li>
|
||
<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>
|
||
<li>
|
||
<a href="#webhook" class="toc-h2 toc-link" data-title="获取仓库单个webhook">获取仓库单个webhook</a>
|
||
</li>
|
||
<li>
|
||
<a href="#webhook-2" class="toc-h2 toc-link" data-title="添加仓库webhook">添加仓库webhook</a>
|
||
</li>
|
||
<li>
|
||
<a href="#webhook-3" class="toc-h2 toc-link" data-title="更新仓库webhook">更新仓库webhook</a>
|
||
</li>
|
||
<li>
|
||
<a href="#webhook-4" class="toc-h2 toc-link" data-title="删除仓库webhook">删除仓库webhook</a>
|
||
</li>
|
||
<li>
|
||
<a href="#webhook-5" class="toc-h2 toc-link" data-title="获取仓库webhook的历史推送列表">获取仓库webhook的历史推送列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#webhook-6" class="toc-h2 toc-link" data-title="仓库webhook测试推送">仓库webhook测试推送</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#pulls" class="toc-h1 toc-link" data-title="Pulls">Pulls</a>
|
||
<ul class="toc-list-h2">
|
||
<li>
|
||
<a href="#get-a-pull-request" class="toc-h2 toc-link" data-title="Get a pull request">Get a pull request</a>
|
||
</li>
|
||
<li>
|
||
<a href="#pull-request" class="toc-h2 toc-link" data-title="获取pull request文件列表">获取pull request文件列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#pull-request-commits" class="toc-h2 toc-link" data-title="获取pull request的commits列表">获取pull request的commits列表</a>
|
||
</li>
|
||
<li>
|
||
<a href="#compare-two-commits" class="toc-h2 toc-link" data-title="Compare two commits">Compare two commits</a>
|
||
</li>
|
||
<li>
|
||
<a href="#list-pull-requests" class="toc-h2 toc-link" data-title="List pull requests">List pull requests</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<a href="#issues" class="toc-h1 toc-link" data-title="Issues">Issues</a>
|
||
</li>
|
||
<li>
|
||
<a href="#organizations" class="toc-h1 toc-link" data-title="Organizations">Organizations</a>
|
||
</li>
|
||
<li>
|
||
<a href="#teams" class="toc-h1 toc-link" data-title="Teams">Teams</a>
|
||
</li>
|
||
<li>
|
||
<a href="#errors" class="toc-h1 toc-link" data-title="Errors">Errors</a>
|
||
</li>
|
||
</ul>
|
||
<ul class="toc-footer">
|
||
<li><a href='https://www.trustie.net/login?login=false'>Sign Up for a User</a></li>
|
||
<li><a href='https://www.trustie.net'>Powered by Trustie</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="page-wrapper">
|
||
<div class="dark-box"></div>
|
||
<div class="content">
|
||
<h1 id='introduction'>Introduction</h1>
|
||
<p>Welcome to the Trustie API! You can use our API to access Trustie API endpoints, which can get information on projects, repository, and users in our platform.</p>
|
||
|
||
<p>We have language bindings in Shell,avaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.</p>
|
||
|
||
<p>This example API documentation page was created with <a href="https://www.trustie.net">Trustie</a>. Feel free to edit it and use it as a base for your own API's documentation.</p>
|
||
<h1 id='licenses'>Licenses</h1><h2 id='get-all-licenses'>Get All Licenses</h2>
|
||
<p>The Licenses API returns metadata about popular open source licenses and information about a particular project's license file.</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">"name=AFL"</span> <span class="se">\</span>
|
||
http://localhost:3000/api/licenses
|
||
</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/licenses</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-request'>HTTP Request</h3>
|
||
<p><code>GET https://forgeplus.trustie.net/api/licenses.json</code></p>
|
||
<h3 id='1f9ac54b15'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Required</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>false</td>
|
||
<td>string</td>
|
||
<td>name of the license</td>
|
||
</tr>
|
||
</tbody></table>
|
||
|
||
<blockquote>
|
||
<p>返回字段说明:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"licenses"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">57</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">"AFL-1.2"</span><span class="w">
|
||
</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">76</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">"AFL-3.0"</span><span class="w">
|
||
</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">214</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">"AFL-1.1"</span><span class="w">
|
||
</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">326</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">"AFL-2.1"</span><span class="w">
|
||
</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">350</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">"AFL-2.0"</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><h1 id='gitignores'>Gitignores</h1><h2 id='gitignore'>gitignore模板列表</h2>
|
||
<p>获取gitignore模板列表, 支持名称搜索过滤</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">"name=Ada"</span> <span class="se">\</span>
|
||
http://localhost:3000/api/ignores.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/ignores.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||
<p><code>GET api/ignores.json</code></p>
|
||
<h3 id='1f9ac54b15'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>否</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6'>返回字段说明</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>gitignore名称</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">"ignores"</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">"id"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Ada"</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 — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<!--
|
||
* @Date: 2021-07-14 15:10:29
|
||
* @LastEditors: viletyy
|
||
* @LastEditTime: 2021-07-14 15:37:23
|
||
* @FilePath: /forgeplus/app/docs/slate/source/includes/_public_keys.md
|
||
-->
|
||
<h1 id='publickeys'>PublicKeys</h1><h2 id='public_keys'>public_keys列表</h2>
|
||
<p>获取public_keys列表，支持分页</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>
|
||
http://localhost:3000/api/public_keys.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/public_keys.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||
<p><code>GET api/public_keys.json</code></p>
|
||
<h3 id='1f9ac54b15'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>page</td>
|
||
<td>否</td>
|
||
<td>1</td>
|
||
<td>int</td>
|
||
<td>页码</td>
|
||
</tr>
|
||
<tr>
|
||
<td>limit</td>
|
||
<td>否</td>
|
||
<td>15</td>
|
||
<td>int</td>
|
||
<td>每页数量</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>总数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>public_keys.id</td>
|
||
<td>int</td>
|
||
<td>ID</td>
|
||
</tr>
|
||
<tr>
|
||
<td>public_keys.name</td>
|
||
<td>string</td>
|
||
<td>密钥标题</td>
|
||
</tr>
|
||
<tr>
|
||
<td>public_keys.content</td>
|
||
<td>string</td>
|
||
<td>密钥内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>public_keys.fingerprint</td>
|
||
<td>string</td>
|
||
<td>密钥标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>public_keys.created_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">"total_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">"public_keys"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">16</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">"xxx"</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">"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDe5ETOTB5PcmcYJkIhfF7+mxmJQDCLg7/LnMoKHpKoo/jYUnFU9OjfsxVo3FTNUvh2475WXMAur5KsFoNKjK9+JHxvoXyJKmyVPWgXU/NRxQyaWPnPLPK8qPRF5ksJE6feBOqtsdxsvBiHs2r1NX/U26Ecnpr6avudD0cmyrEfbYMWbupLrhsd39dswPT73f3W5jc7B9Y47Ioiv8UOju3ABt1+kpuAjaaVC6VtUQoEFiZb1y33yBnyePya7dvFyApyD4ILyyIG2rtZWK7l53YFnwZDuFsTWjEEEQD0U4FBSFdH5wtwx0WQLMSNyTtaFBSG0kJ+uiQQIrxlvikcm63df7zbC3/rWLPsKgW122Zt966dcpFqiCiJNDKZPPw3qpg8TBL6X+qIZ+FxVEk/16/zScpyEfoxQp0GvgxI7hPLErmfkC5tMsib8MAXYBNyvJXna0vg/wOaNNIaI4SAH9Ksh3f/TtalYVjp6WxIwVBfnbq51WnmlnEXePtX6XjAGL+GbF2VQ1nv/IzrY09tNbTV6wQsrSIP3VDzYQxdJ1rdsVNMoJB0H2Pu0NdcSz53Wx45N+myD0QnE05ss+zDp5StY90OYsx2aCo6qAA8Qn2jUjdta7MQWwkPfKrta4tTQ0XbWMjx4/E1+l3J5liwZkl2XOGOwhfXdRsBjaEziZ18kQ== yystopf@163.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"fingerprint"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SHA256:cU8AK/+roqUUyiaYXIdS2Nj4+Rb2p6rqWSeRDc+aqKM"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"created_unix"</span><span class="p">:</span><span class="w"> </span><span class="mi">1626246596</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">"2021/07/14 15:09"</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 — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<h2 id='public_key'>创建public_key</h2>
|
||
<p>创建public_key</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/public_keys.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/public_keys.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-2'>HTTP 请求</h3>
|
||
<p><code>POST api/public_keys.json</code></p>
|
||
<h3 id='1f9ac54b15-2'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>key</td>
|
||
<td>是</td>
|
||
<td>否</td>
|
||
<td>string</td>
|
||
<td>密钥</td>
|
||
</tr>
|
||
<tr>
|
||
<td>title</td>
|
||
<td>是</td>
|
||
<td>否</td>
|
||
<td>string</td>
|
||
<td>密钥标题</td>
|
||
</tr>
|
||
</tbody></table>
|
||
|
||
<blockquote>
|
||
<p>请求的JSON示例：
|
||
<code>json
|
||
{
|
||
"public_key": {
|
||
"key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDe5ETOTB5PcmcYJkIhfF7+mxmJQDCLg7/LnMoKHpKoo/jYUnFU9OjfsxVo3FTNUvh2475WXMAur5KsFoNKjK9+JHxvoXyJKmyVPWgXU/NRxQyaWPnPLPK8qPRF5ksJE6feBOqtsdxsvBiHs2r1NX/U26Ecnpr6avudD0cmyrEfbYMWbupLrhsd39dswPT73f3W5jc7B9Y47Ioiv8UOju3ABt1+kpuAjaaVC6VtUQoEFiZb1y33yBnyePya7dvFyApyD4ILyyIG2rtZWK7l53YFnwZDuFsTWjEEEQD0U4FBSFdH5wtwx0WQLMSNyTtaFBSG0kJ+uiQQIrxlvikcm63df7zbC3/rWLPsKgW122Zt966dcpFqiCiJNDKZPPw3qpg8TBL6X+qIZ+FxVEk/16/zScpyEfoxQp0GvgxI7hPLErmfkC5tMsib8MAXYBNyvJXna0vg/wOaNNIaI4SAH9Ksh3f/TtalYVjp6WxIwVBfnbq51WnmlnEXePtX6XjAGL+GbF2VQ1nv/IzrY09tNbTV6wQsrSIP3VDzYQxdJ1rdsVNMoJB0H2Pu0NdcSz53Wx45N+myD0QnE05ss+zDp5StY90OYsx2aCo6qAA8Qn2jUjdta7MQWwkPfKrta4tTQ0XbWMjx4/E1+l3J5liwZkl2XOGOwhfXdRsBjaEziZ18kQ== yystopf@163.com",
|
||
"title": "xxx"
|
||
}
|
||
}
|
||
</code></p>
|
||
</blockquote>
|
||
<h3 id='b302a98fa6-2'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>总数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>int</td>
|
||
<td>ID</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>密钥标题</td>
|
||
</tr>
|
||
<tr>
|
||
<td>content</td>
|
||
<td>string</td>
|
||
<td>密钥内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>fingerprint</td>
|
||
<td>string</td>
|
||
<td>密钥标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>created_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">17</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">"xxx"</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">"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDe5ETOTB5PcmcYJkIhfF7+mxmJQDCLg7/LnMoKHpKoo/jYUnFU9OjfsxVo3FTNUvh2475WXMAur5KsFoNKjK9+JHxvoXyJKmyVPWgXU/NRxQyaWPnPLPK8qPRF5ksJE6feBOqtsdxsvBiHs2r1NX/U26Ecnpr6avudD0cmyrEfbYMWbupLrhsd39dswPT73f3W5jc7B9Y47Ioiv8UOju3ABt1+kpuAjaaVC6VtUQoEFiZb1y33yBnyePya7dvFyApyD4ILyyIG2rtZWK7l53YFnwZDuFsTWjEEEQD0U4FBSFdH5wtwx0WQLMSNyTtaFBSG0kJ+uiQQIrxlvikcm63df7zbC3/rWLPsKgW122Zt966dcpFqiCiJNDKZPPw3qpg8TBL6X+qIZ+FxVEk/16/zScpyEfoxQp0GvgxI7hPLErmfkC5tMsib8MAXYBNyvJXna0vg/wOaNNIaI4SAH9Ksh3f/TtalYVjp6WxIwVBfnbq51WnmlnEXePtX6XjAGL+GbF2VQ1nv/IzrY09tNbTV6wQsrSIP3VDzYQxdJ1rdsVNMoJB0H2Pu0NdcSz53Wx45N+myD0QnE05ss+zDp5StY90OYsx2aCo6qAA8Qn2jUjdta7MQWwkPfKrta4tTQ0XbWMjx4/E1+l3J5liwZkl2XOGOwhfXdRsBjaEziZ18kQ== yystopf@163.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"fingerprint"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SHA256:cU8AK/+roqUUyiaYXIdS2Nj4+Rb2p6rqWSeRDc+aqKM"</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">"2021/07/14 15:26"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<h2 id='public_key-2'>删除public_key</h2>
|
||
<p>删除public_key</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<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/public_keys/:id.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/public_keys/:id.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-3'>HTTP 请求</h3>
|
||
<p><code>DELETE api/public_keys/:id.json</code></p>
|
||
<h3 id='1f9ac54b15-3'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>是</td>
|
||
<td>否</td>
|
||
<td>int</td>
|
||
<td>密钥ID</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<!--
|
||
* @Date: 2021-03-01 10:35:21
|
||
* @LastEditors: viletyy
|
||
* @LastEditTime: 2021-09-15 18:00:10
|
||
* @FilePath: /forgeplus/app/docs/slate/source/includes/_users.md
|
||
-->
|
||
<h1 id='users'>Users</h1><h2 id='1ae74893b1'>获取当前登陆用户信息</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/users/me.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/users/me.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||
<p><code>GET api/users/me.json</code></p>
|
||
<h3 id='7447e4874e'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>user_id</td>
|
||
<td>int</td>
|
||
<td>用户id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>username</td>
|
||
<td>string</td>
|
||
<td>用户名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>admin</td>
|
||
<td>boolean</td>
|
||
<td>是否为管理用户</td>
|
||
</tr>
|
||
<tr>
|
||
<td>login</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">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"username"</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">"login"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">100000</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">"avatars/User/b"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"admin"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='5b752913ae'>用户消息列表</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/users/:login/messages.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/users/:login/messages.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-2'>HTTP 请求</h3>
|
||
<p><code>GET api/users/yystopf/messages.json</code></p>
|
||
<h3 id='aa883f5d52'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>消息类型，不传为所有消息，notification为系统消息，atme为@我消息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>integer</td>
|
||
<td>是否已读，不传为所有消息，1为未读，2为已读</td>
|
||
</tr>
|
||
<tr>
|
||
<td>limit</td>
|
||
<td>integer</td>
|
||
<td>每页个数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>page</td>
|
||
<td>integer</td>
|
||
<td>页码</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-2'>返回字段说明:</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>type</td>
|
||
<td>string</td>
|
||
<td>消息类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>unread_notification</td>
|
||
<td>integer</td>
|
||
<td>未读系统通知数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>unread_atme</td>
|
||
<td>integer</td>
|
||
<td>未读@我数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.id</td>
|
||
<td>integer</td>
|
||
<td>消息id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.status</td>
|
||
<td>integer</td>
|
||
<td>消息是否已读，1为未读，2为已读</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.content</td>
|
||
<td>string</td>
|
||
<td>消息内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.notification_url</td>
|
||
<td>string</td>
|
||
<td>消息跳转地址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.source</td>
|
||
<td>string</td>
|
||
<td>消息来源</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.timeago</td>
|
||
<td>string</td>
|
||
<td>消息时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>messages.type</td>
|
||
<td>string</td>
|
||
<td>消息类型，notification为系统消息，atme为@我消息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>sender</td>
|
||
<td>object</td>
|
||
<td>消息发送者</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h4 id='source'>消息来源source字段说明</h4>
|
||
<table><thead>
|
||
<tr>
|
||
<th>类型</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>IssueAssigned</td>
|
||
<td>有新指派给我的疑修</td>
|
||
</tr>
|
||
<tr>
|
||
<td>IssueExpire</td>
|
||
<td>我创建或负责的疑修截止日期到达最后一天</td>
|
||
</tr>
|
||
<tr>
|
||
<td>IssueAtme</td>
|
||
<td>在疑修中@我</td>
|
||
</tr>
|
||
<tr>
|
||
<td>IssueChanged</td>
|
||
<td>我创建或负责的疑修状态变更</td>
|
||
</tr>
|
||
<tr>
|
||
<td>IssueDeleted</td>
|
||
<td>我创建或负责的疑修删除</td>
|
||
</tr>
|
||
<tr>
|
||
<td>IssueJournal</td>
|
||
<td>我创建或负责的疑修有新的评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>LoginIpTip</td>
|
||
<td>登录异常提示</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OrganizationJoined</td>
|
||
<td>账号被拉入组织</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OrganizationLeft</td>
|
||
<td>账号被移出组织</td>
|
||
</tr>
|
||
<tr>
|
||
<td>OrganizationRole</td>
|
||
<td>账号组织权限变更</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectDeleted</td>
|
||
<td>我关注的仓库被删除</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectFollowed</td>
|
||
<td>我管理的仓库被关注</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectForked</td>
|
||
<td>我管理的仓库被复刻</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectIssue</td>
|
||
<td>我管理/关注的仓库有新的疑修</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectJoined</td>
|
||
<td>账号被拉入项目</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectLeft</td>
|
||
<td>账号被移出项目</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectMemberJoined</td>
|
||
<td>我管理的仓库有成员加入</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectMemberLeft</td>
|
||
<td>我管理的仓库有成员移出</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectMilestoneCompleted</td>
|
||
<td>我管理的仓库有里程碑完成度100%</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectMilestone</td>
|
||
<td>我管理的仓库有新的里程碑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectPraised</td>
|
||
<td>我管理的仓库被点赞</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectPullRequest</td>
|
||
<td>我管理/关注的仓库有新的合并请求</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectRole</td>
|
||
<td>账号仓库权限变更</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectSettingChanged</td>
|
||
<td>我管理的仓库项目设置被更改</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectTransfer</td>
|
||
<td>我关注的仓库被转移</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ProjectVersion</td>
|
||
<td>我关注的仓库有新的发行版</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PullRequestAssigned</td>
|
||
<td>有新指派给我的合并请求</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PullReuqestAtme</td>
|
||
<td>在合并请求中@我</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PullRequestChanged</td>
|
||
<td>我创建或负责的合并请求状态变更</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PullRequestClosed</td>
|
||
<td>我创建或负责的合并请求被关闭</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PullRequestJournal</td>
|
||
<td>我创建或负责的合并请求有新的评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>PullRequestMerged</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">"total_count"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"unread_notification"</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">"unread_atme"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"messages"</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">"id"</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">"status"</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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Atme Message Content 1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://www.baidu.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequestAtme"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"atme"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sender"</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">5</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">"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">"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="p">{</span><span class="w">
|
||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Atme Message Content 2"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://www.baidu.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"IssueAtme"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"atme"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sender"</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">"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">"testforge1"</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">"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="nl">"id"</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">"status"</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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Notification Message Content 1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://www.baidu.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"IssueDelete"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"notification"</span><span class="w">
|
||
</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">"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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Notification Message Content 2"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://www.baidu.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"IssueChanged"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"notification"</span><span class="w">
|
||
</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">5</span><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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Notification Message Content 3"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://www.baidu.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ProjectJoined"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"notification"</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='6087e717ed'>用户阅读系统通知</h2>
|
||
<p>用户阅读系统通知</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/system_notification_histories.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/users/:login/system_notification_histories.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-3'>HTTP 请求</h3>
|
||
<p><code>POST /api/users/:login/system_notification_histories.json</code></p>
|
||
<h3 id='aa883f5d52-2'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>system_notification_id</td>
|
||
<td>integer</td>
|
||
<td>阅读的系统通知id</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='94306b2fc3'>发送消息</h2>
|
||
<p>发送消息, 目前只支持atme</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/:login/messages.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/users/:login/messages.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-4'>HTTP 请求</h3>
|
||
<p><code>POST api/users/yystopf/messages.json</code></p>
|
||
<h3 id='aa883f5d52-3'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>消息类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>receivers_login</td>
|
||
<td>array</td>
|
||
<td>需要发送消息的用户名数组</td>
|
||
</tr>
|
||
<tr>
|
||
<td>atmeable_type</td>
|
||
<td>string</td>
|
||
<td>atme消息对象，是从哪里@我的，比如评论：Journal、疑修：Issue、合并请求：PullRequest</td>
|
||
</tr>
|
||
<tr>
|
||
<td>atmeable_id</td>
|
||
<td>integer</td>
|
||
<td>atme消息对象id</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">"atme"</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="s2">"yystopf"</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">"atmeable_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Journal"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"atmeable_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">67</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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='d69a1523bb'>阅读消息</h2>
|
||
<p>阅读消息</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/:login/messages/read.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/users/:login/messages/read.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-5'>HTTP 请求</h3>
|
||
<p><code>POST api/users/yystopf/messages/read.json</code></p>
|
||
<h3 id='aa883f5d52-4'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>消息类型，不传为所有消息，notification为系统消息，atme为@我消息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ids</td>
|
||
<td>array</td>
|
||
<td>消息id数组，包含-1则把所有未读消息标记为已读</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='c5dc622a5a'>删除消息</h2>
|
||
<p>删除消息</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE http://localhost:3000/api/users/:login/messages.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/users/:login/messages.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-6'>HTTP 请求</h3>
|
||
<p><code>DELETE api/users/yystopf/messages.json</code></p>
|
||
<h3 id='aa883f5d52-5'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>消息类型，atme为@我消息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ids</td>
|
||
<td>array</td>
|
||
<td>消息id数组，包含-1则把所有消息删除</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='c6da6881ac'>更改用户信息</h2>
|
||
<p>更改用户信息</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PATCH/PUT http://localhost:3000/api/users/yystopf.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/PUT /api/users/:login.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-7'>HTTP 请求</h3>
|
||
<p><code>PATCH/PUT /api/users/:login.json</code></p>
|
||
<h3 id='aa883f5d52-6'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>user.nickname</td>
|
||
<td>string</td>
|
||
<td>用户昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.image</td>
|
||
<td>base64/file</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.gender</td>
|
||
<td>int</td>
|
||
<td>性别， 0男 1女</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.province</td>
|
||
<td>string</td>
|
||
<td>省份</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.city</td>
|
||
<td>string</td>
|
||
<td>城市</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.description</td>
|
||
<td>string</td>
|
||
<td>简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.custom_department</td>
|
||
<td>string</td>
|
||
<td>单位名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.technical_title</td>
|
||
<td>string</td>
|
||
<td>职业</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.show_email</td>
|
||
<td>bool</td>
|
||
<td>是否展示邮箱</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.show_location</td>
|
||
<td>bool</td>
|
||
<td>是否展示位置</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.user_extension_attributes.show_department</td>
|
||
<td>bool</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">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"xxx"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_extension_attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"gender"</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">"province"</span><span class="p">:</span><span class="w"> </span><span class="s2">"湖南"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"city"</span><span class="p">:</span><span class="w"> </span><span class="s2">"长沙"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"个性签名"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"custom_department"</span><span class="p">:</span><span class="w"> </span><span class="s2">"湖南智擎科技有限公司"</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>
|
||
<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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='8469c9a565'>获取平台消息设置配置信息</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/template_message_settings.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/template_message_settings.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-8'>HTTP 请求</h3>
|
||
<p><code>GET /api/template_message_settings.json</code></p>
|
||
<h3 id='7447e4874e-3'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>消息配置类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type_name</td>
|
||
<td>string</td>
|
||
<td>消息配置类型含义</td>
|
||
</tr>
|
||
<tr>
|
||
<td>total_settings_count</td>
|
||
<td>int</td>
|
||
<td>配置条数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>settings.name</td>
|
||
<td>string</td>
|
||
<td>配置名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>settings.key</td>
|
||
<td>string</td>
|
||
<td>配置标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>settings.notification_disabled</td>
|
||
<td>boolean</td>
|
||
<td>站内信设置是否禁用</td>
|
||
</tr>
|
||
<tr>
|
||
<td>settings.email_disabled</td>
|
||
<td>boolean</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">"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">"setting_types"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TemplateMessageSetting::Normal"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"type_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"total_settings_count"</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">"settings"</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">"被拉入或移出组织"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Organization"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"被拉入或移出项目"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Project"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"有权限变更"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Permission"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TemplateMessageSetting::CreateOrAssign"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"type_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"我创建的或负责的"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"total_settings_count"</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">"settings"</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">"疑修被指派"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"IssueAssigned"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"合并请求被指派"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequestAssigned"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TemplateMessageSetting::ManageProject"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"type_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"我管理的仓库"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"total_settings_count"</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">"settings"</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">"有新的疑修"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Issue"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"有新的合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"有成员变动"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Member"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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">"设置更改"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SettingChanged"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"notification_disabled"</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">"email_disabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='e731847818'>获取用户消息设置配置信息</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/users/yystopf/template_message_settings.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/uses/yystopf/template_message_settings.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-9'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:user_id/template_message_settings.json</code></p>
|
||
<h3 id='7447e4874e-4'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>notification_body</td>
|
||
<td>string</td>
|
||
<td>站内信配置</td>
|
||
</tr>
|
||
<tr>
|
||
<td>email_body</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">"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">"user"</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">2</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">"heh"</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">"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="nl">"notification_body"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CreateOrAssign::IssueAssigned"</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">"CreateOrAssign::PullRequestAssigned"</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">"ManageProject::Issue"</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">"ManageProject::PullRequest"</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">"ManageProject::Member"</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">"ManageProject::SettingChanged"</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">"Normal::Organization"</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">"Normal::Project"</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">"Normal::Permission"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"email_body"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CreateOrAssign::IssueAssigned"</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">"CreateOrAssign::PullRequestAssigned"</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">"ManageProject::Issue"</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">"ManageProject::PullRequest"</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">"ManageProject::Member"</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">"ManageProject::SettingChanged"</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">"Normal::Organization"</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">"Normal::Project"</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">"Normal::Permission"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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='47e7414364'>重新设置用户消息设置配置信息</h2>
|
||
<p>重新设置用户消息设置配置信息</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/template_message_settings/update_setting.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/uses/yystopf/template_message_settings/update_setting.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-10'>HTTP 请求</h3>
|
||
<p><code>POST /api/users/:user_id/template_message_settings/update_setting.json</code></p>
|
||
<h3 id='aa883f5d52-7'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>notification_body</td>
|
||
<td>string</td>
|
||
<td>站内信配置</td>
|
||
</tr>
|
||
<tr>
|
||
<td>email_body</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">"setting"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"notification_body"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CreateOrAssign::IssueAssigned"</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">"CreateOrAssign::PullRequestAssigned"</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">"ManageProject::Issue"</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">"ManageProject::PullRequest"</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">"ManageProject::Member"</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">"ManageProject::SettingChanged"</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">"Normal::Organization"</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">"Normal::Project"</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">"Normal::Permission"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"email_body"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CreateOrAssign::IssueAssigned"</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">"CreateOrAssign::PullRequestAssigned"</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">"ManageProject::Issue"</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">"ManageProject::PullRequest"</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">"ManageProject::Member"</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">"ManageProject::SettingChanged"</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">"Normal::Organization"</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">"Normal::Project"</span><span class="p">:</span><span class="w"> </span><span class="s2">"t"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Normal::Permission"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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><h3 id='7447e4874e-5'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>notification_body</td>
|
||
<td>string</td>
|
||
<td>站内信配置</td>
|
||
</tr>
|
||
<tr>
|
||
<td>email_body</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">"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">"user"</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">2</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">"heh"</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">"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="nl">"notification_body"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CreateOrAssign::IssueAssigned"</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">"CreateOrAssign::PullRequestAssigned"</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">"ManageProject::Issue"</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">"ManageProject::PullRequest"</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">"ManageProject::Member"</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">"ManageProject::SettingChanged"</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">"Normal::Organization"</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">"Normal::Project"</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">"Normal::Permission"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"email_body"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CreateOrAssign::IssueAssigned"</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">"CreateOrAssign::PullRequestAssigned"</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">"ManageProject::Issue"</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">"ManageProject::PullRequest"</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">"ManageProject::Member"</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">"ManageProject::SettingChanged"</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">"Normal::Organization"</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">"Normal::Project"</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">"Normal::Permission"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</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='16a4666845'>获取用户星标项目</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/users/yystopf/is_pinned_projects.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/users/:login/is_pinned_projects.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-11'>HTTP 请求</h3>
|
||
<p><code>GET api/users/:login/is_pinned_projects.json</code></p>
|
||
<h3 id='7447e4874e-6'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>星标项目数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>identifier</td>
|
||
<td>string</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>项目描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>visits</td>
|
||
<td>int</td>
|
||
<td>项目访问数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>praises_count</td>
|
||
<td>int</td>
|
||
<td>项目点赞数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>watchers_count</td>
|
||
<td>int</td>
|
||
<td>项目关注数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issues_count</td>
|
||
<td>int</td>
|
||
<td>项目issue数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_requests_count</td>
|
||
<td>int</td>
|
||
<td>项目合并请求数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>forked_count</td>
|
||
<td>int</td>
|
||
<td>项目复刻数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_public</td>
|
||
<td>bool</td>
|
||
<td>项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>mirror_url</td>
|
||
<td>string</td>
|
||
<td>镜像地址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>int</td>
|
||
<td>项目类型 0 普通项目 1 普通镜像项目 2 同步镜像项目</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>上次更新时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>open_devops</td>
|
||
<td>int</td>
|
||
<td>是否开启devops</td>
|
||
</tr>
|
||
<tr>
|
||
<td>forked_from_project_id</td>
|
||
<td>int</td>
|
||
<td>fork项目id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>platform</td>
|
||
<td>string</td>
|
||
<td>项目平台</td>
|
||
</tr>
|
||
<tr>
|
||
<td>author.name</td>
|
||
<td>string</td>
|
||
<td>项目拥有者名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>author.type</td>
|
||
<td>string</td>
|
||
<td>项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>author.login</td>
|
||
<td>string</td>
|
||
<td>项目拥有者用户名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>author.image_url</td>
|
||
<td>string</td>
|
||
<td>项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>category.name</td>
|
||
<td>string</td>
|
||
<td>项目分类名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>language.name</td>
|
||
<td>string</td>
|
||
<td>项目语言名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>position</td>
|
||
<td>int</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">"total_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">"projects"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">89</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">89</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"monkey"</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">"boke"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dkkd"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"visits"</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">"praises_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">"watchers_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">"issues_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">"pull_requests_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">"forked_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">"is_public"</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">"mirror_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.com/viletyy/monkey.git"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"type"</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">"last_update_time"</span><span class="p">:</span><span class="w"> </span><span class="mi">1619685144</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">"27天前"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"forked_from_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">"open_devops"</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">"platform"</span><span class="p">:</span><span class="w"> </span><span class="s2">"forge"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"测试组织"</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">"Organization"</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">"ceshi_org"</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">"images/avatars/Organization/9?t=1612706073"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"category"</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">3</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">"深度学习"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"language"</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">2</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">"C"</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='3064477f38'>用户添加星标项目</h2>
|
||
<p>用户添加星标项目</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/is_pinned_projects/pin.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/users/:login/is_pinned_projects/pin.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-12'>HTTP 请求</h3>
|
||
<p><code>POST /api/users/:login/is_pinned_projects/pin.json</code></p>
|
||
<h3 id='aa883f5d52-8'>请求字段说明:</h3><h4 id='0ca7f0efb8'>同时设定多个星标项目</h4>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>is_pinned_project_ids</td>
|
||
<td>array</td>
|
||
<td>设定为星标项目的id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h4 id='f4b9f10991'>只设定一个星标项目</h4>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>is_pinned_project_id</td>
|
||
<td>integer</td>
|
||
<td>设定为星标项目的id</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='3f31dec5ae'>星标项目展示排序</h2>
|
||
<p>星标项目展示排序</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PATCH http://localhost:3000/api/users/yystopf/is_pinned_projects/11.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/PUT /api/users/:login/is_pinned_projects/:id.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-13'>HTTP 请求</h3>
|
||
<p><code>PATCH/PUT /api/users/:login/is_pinned_projects/:id.json</code></p>
|
||
<h3 id='aa883f5d52-9'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>pinned_projects.position</td>
|
||
<td>int</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">"pinned_project"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="mi">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>
|
||
<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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='4a39412749'>用户近期活动统计</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/users/yystopf/statistics/activity.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/users/:login/statistics/activity.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-14'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/statistics/activity.json</code></p>
|
||
<h3 id='7447e4874e-7'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>dates</td>
|
||
<td>array</td>
|
||
<td>时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issues_count</td>
|
||
<td>array</td>
|
||
<td>疑修数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_requests_count</td>
|
||
<td>array</td>
|
||
<td>合并请求数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>commtis_count</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">"dates"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="s2">"2021.05.21"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.22"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.23"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.24"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.25"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.26"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.27"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"2021.05.28"</span><span class="w">
|
||
</span><span class="p">],</span><span class="w">
|
||
</span><span class="nl">"issues_count"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="w">
|
||
</span><span class="p">],</span><span class="w">
|
||
</span><span class="nl">"pull_requests_count"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="w">
|
||
</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="p">[</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="mi">0</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='04cb758654'>获取用户贡献度</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/users/yystopf/headmaps.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/users/:login/headmaps.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-15'>HTTP 请求</h3>
|
||
<p><code>GET api/users/:login/headmaps.json</code></p>
|
||
<h3 id='aa883f5d52-10'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>year</td>
|
||
<td>string</td>
|
||
<td>年份</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-8'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_contributions</td>
|
||
<td>int</td>
|
||
<td>所选时间内的总贡献度</td>
|
||
</tr>
|
||
<tr>
|
||
<td>headmaps.date</td>
|
||
<td>string</td>
|
||
<td>时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>headmaps.contributions</td>
|
||
<td>int</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">"total_contributions"</span><span class="p">:</span><span class="w"> </span><span class="mi">139</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"headmaps"</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">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-02-07"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-02-21"</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">13</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-02-25"</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="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-03-01"</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">2</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-03-04"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-03-15"</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">9</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-03-22"</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">14</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-03-24"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-03-30"</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">11</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-06"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-12"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-13"</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">2</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-19"</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">3</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-23"</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">37</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-25"</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">2</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-26"</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">6</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-28"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-29"</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">18</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-30"</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">9</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-05-04"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-05-06"</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">1</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='7931751284'>获取用户动态</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/users/yystopf/project_trends.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/users/:login/project_trends.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-16'>HTTP 请求</h3>
|
||
<p><code>GET api/users/:login/project_trends.json</code></p>
|
||
<h3 id='aa883f5d52-11'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>date</td>
|
||
<td>string</td>
|
||
<td>日期，格式: 2021-05-28</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-9'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>所选时间内的总动态数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.trend_type</td>
|
||
<td>string</td>
|
||
<td>动态类型，Issue：疑修，VersionRelease：版本发布，PullRequest：合并请求</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.action_type</td>
|
||
<td>string</td>
|
||
<td>操作类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.trend_id</td>
|
||
<td>integer</td>
|
||
<td>动态id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.user_name</td>
|
||
<td>string</td>
|
||
<td>用户名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.user_login</td>
|
||
<td>string</td>
|
||
<td>用户用户名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.user_avatar</td>
|
||
<td>string</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.action_time</td>
|
||
<td>string</td>
|
||
<td>操作时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_trends.name</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">"total_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">16</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_trends"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">27</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Issue"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了工单"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"31213123123"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"issue_type"</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">"status_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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="mi">4</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">"2021-05-07 15:39"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-05-27 15:42"</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">"yystopf"</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">"issue_journal_size"</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">"issue_journals"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VersionRelease"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了版本发布"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"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">"heihei1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"tag_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v1.0"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"target_commitish"</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">"tarball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/forgeceshiorg1/ceshi1/archive/v1.0.tar.gz"</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:10080/forgeceshiorg1/ceshi1/archive/v1.0.zip"</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:10080/api/v1/repos/forgeceshiorg1/ceshi1/releases/84"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"version_gid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"84"</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">"2021-05-04 12:04"</span><span class="w">
|
||
</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">25</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"关闭了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">14</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"13"</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">"2021-04-30 15:39"</span><span class="w">
|
||
</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">24</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">13</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"211212"</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">"2021-04-30 15:37"</span><span class="w">
|
||
</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">23</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</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">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"奇偶哦iu"</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">"2021-04-30 10:19"</span><span class="w">
|
||
</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">22</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</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">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"2112123"</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">"2021-04-29 18:46"</span><span class="w">
|
||
</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">21</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"关闭了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</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">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"23123"</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">"2021-04-29 18:45"</span><span class="w">
|
||
</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">20</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"33"</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">"2021-04-29 18:37"</span><span class="w">
|
||
</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">19</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"关闭了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"28天前"</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">"gggg"</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">"2021-04-29 17:51"</span><span class="w">
|
||
</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">16</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Issue"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了工单"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hjhkj"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"issue_type"</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">"status_id"</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">"priority_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"2021-04-19 10:52"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-04-19 10:52"</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="kc">null</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="kc">null</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"issue_journal_size"</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_journals"</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">"id"</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">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VersionRelease"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了版本发布"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</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">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v3.0.1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"tag_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v3.0.1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"target_commitish"</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">"tarball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshirepo1/archive/v3.0.1.tar.gz"</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:10080/yystopf/ceshirepo1/archive/v3.0.1.zip"</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:10080/api/v1/repos/yystopf/ceshirepo1/releases/78"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"version_gid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"78"</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">"2021-03-30 15:51"</span><span class="w">
|
||
</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">6</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VersionRelease"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了版本发布"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</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">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v3.0.0"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"tag_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v3.0.0"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"target_commitish"</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">"tarball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshirepo1/archive/v3.0.0.tar.gz"</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:10080/yystopf/ceshirepo1/archive/v3.0.0.zip"</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:10080/api/v1/repos/yystopf/ceshirepo1/releases/77"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"version_gid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"77"</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">"2021-03-30 15:33"</span><span class="w">
|
||
</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">5</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VersionRelease"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了版本发布"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</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">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_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">"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">"tag_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">"target_commitish"</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">"tarball_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshirepo1/archive/v1.0.0.tar.gz"</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:10080/yystopf/ceshirepo1/archive/v1.0.0.zip"</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:10080/api/v1/repos/yystopf/ceshirepo1/releases/76"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"version_gid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"76"</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">"2021-03-30 15:27"</span><span class="w">
|
||
</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">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"VersionRelease"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了版本发布"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vvvv"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"tag_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v1.1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"target_commitish"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dev"</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:10080/yystopf/virus_blog/archive/v1.1.tar.gz"</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:10080/yystopf/virus_blog/archive/v1.1.zip"</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:10080/api/v1/repos/yystopf/virus_blog/releases/6"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"version_gid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6"</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">"2021-03-15 14:18"</span><span class="w">
|
||
</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">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PullRequest"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"action_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"创建了合并请求"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"trend_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"user_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">"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">"user_avatar"</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="p">,</span><span class="w">
|
||
</span><span class="nl">"action_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3个月前"</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">"444"</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">"2021-02-25 17:31"</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='02488a20d5'>用户开发能力</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/users/yystopf/statistics/develop.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/users/:login/statistics/develop.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-17'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/statistics/develop.json</code></p>
|
||
<h3 id='aa883f5d52-12'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>start_time</td>
|
||
<td>integer</td>
|
||
<td>时间戳，开始时间，格式：1621526400</td>
|
||
</tr>
|
||
<tr>
|
||
<td>end_time</td>
|
||
<td>integer</td>
|
||
<td>时间戳，结束时间，格式：1622131200</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-10'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>influence</td>
|
||
<td>int</td>
|
||
<td>影响力</td>
|
||
</tr>
|
||
<tr>
|
||
<td>contribution</td>
|
||
<td>int</td>
|
||
<td>贡献度</td>
|
||
</tr>
|
||
<tr>
|
||
<td>activity</td>
|
||
<td>int</td>
|
||
<td>活跃度</td>
|
||
</tr>
|
||
<tr>
|
||
<td>experience</td>
|
||
<td>int</td>
|
||
<td>项目经验</td>
|
||
</tr>
|
||
<tr>
|
||
<td>language</td>
|
||
<td>int</td>
|
||
<td>语言能力</td>
|
||
</tr>
|
||
<tr>
|
||
<td>languages_percent</td>
|
||
<td>float</td>
|
||
<td>语言百分比</td>
|
||
</tr>
|
||
<tr>
|
||
<td>each_language_score</td>
|
||
<td>int</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">"platform"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"influence"</span><span class="p">:</span><span class="w"> </span><span class="mi">61</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"contribution"</span><span class="p">:</span><span class="w"> </span><span class="mi">75</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"activity"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"experience"</span><span class="p">:</span><span class="w"> </span><span class="mi">95</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"language"</span><span class="p">:</span><span class="w"> </span><span class="mi">87</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"languages_percent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CSS"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.03</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C#"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.13</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Ruby"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.04</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Go"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.05</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.19</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Java"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.34</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Python"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.09</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C+"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.01</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C++"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.11</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Scala"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.01</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"HTML"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.01</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"each_language_score"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"CSS"</span><span class="p">:</span><span class="w"> </span><span class="mi">71</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C#"</span><span class="p">:</span><span class="w"> </span><span class="mi">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Ruby"</span><span class="p">:</span><span class="w"> </span><span class="mi">75</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Go"</span><span class="p">:</span><span class="w"> </span><span class="mi">77</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C"</span><span class="p">:</span><span class="w"> </span><span class="mi">90</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Java"</span><span class="p">:</span><span class="w"> </span><span class="mi">93</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Python"</span><span class="p">:</span><span class="w"> </span><span class="mi">83</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C+"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C++"</span><span class="p">:</span><span class="w"> </span><span class="mi">85</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Scala"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"HTML"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"influence"</span><span class="p">:</span><span class="w"> </span><span class="mi">60</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"contribution"</span><span class="p">:</span><span class="w"> </span><span class="mi">72</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"activity"</span><span class="p">:</span><span class="w"> </span><span class="mi">65</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"experience"</span><span class="p">:</span><span class="w"> </span><span class="mi">88</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"language"</span><span class="p">:</span><span class="w"> </span><span class="mi">84</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"languages_percent"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"C"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.25</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C#"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.33</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C++"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.13</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"CSS"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.08</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Go"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.04</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"HTML"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.04</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Java"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.04</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Ruby"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.08</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"each_language_score"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"C"</span><span class="p">:</span><span class="w"> </span><span class="mi">81</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C#"</span><span class="p">:</span><span class="w"> </span><span class="mi">84</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"C++"</span><span class="p">:</span><span class="w"> </span><span class="mi">75</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"CSS"</span><span class="p">:</span><span class="w"> </span><span class="mi">71</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Go"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"HTML"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Java"</span><span class="p">:</span><span class="w"> </span><span class="mi">66</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Ruby"</span><span class="p">:</span><span class="w"> </span><span class="mi">71</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='aa848a4fa0'>用户角色定位</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/users/yystopf/statistics/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">GET /api/users/:login/statistics/role.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-18'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/statistics/role.json</code></p>
|
||
<h3 id='aa883f5d52-13'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>start_time</td>
|
||
<td>integer</td>
|
||
<td>时间戳，开始时间，格式：1621526400</td>
|
||
</tr>
|
||
<tr>
|
||
<td>end_time</td>
|
||
<td>integer</td>
|
||
<td>时间戳，结束时间，格式：1622131200</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-11'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_projects_count</td>
|
||
<td>int</td>
|
||
<td>用户所有的项目数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role.object.count</td>
|
||
<td>int</td>
|
||
<td>用户该语言下的项目数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role.object.percent</td>
|
||
<td>float</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">"total_projects_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">27</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"role"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"owner"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"count"</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">"percent"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.89</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"manager"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"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">"percent"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.04</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"developer"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"percent"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.07</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"reporter"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"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">"percent"</span><span class="p">:</span><span class="w"> </span><span class="mf">0.0</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='ae21e852b6'>用户专业定位</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/users/yystopf/statistics/major.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/users/:login/statistics/major.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-19'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/statistics/major.json</code></p>
|
||
<h3 id='aa883f5d52-14'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>start_time</td>
|
||
<td>integer</td>
|
||
<td>时间戳，开始时间，格式：1621526400</td>
|
||
</tr>
|
||
<tr>
|
||
<td>end_time</td>
|
||
<td>integer</td>
|
||
<td>时间戳，结束时间，格式：1622131200</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-12'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>categories</td>
|
||
<td>int</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">"categories"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="s2">"大数据"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"机器学习"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"深度学习"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"人工智能"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"智慧医疗"</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></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='fcaf20021b'>待办事项-用户通知信息</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/users/yystopf/applied_messages.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/users/:login/applied_messages.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-20'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_messages.json</code></p>
|
||
<h3 id='aa883f5d52-15'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-13'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>applied</td>
|
||
<td>object</td>
|
||
<td>通知主体</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.id</td>
|
||
<td>int</td>
|
||
<td>通知主体的迁移id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.status</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.time_ago</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.id</td>
|
||
<td>int</td>
|
||
<td>通知主体的迁移项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.identifier</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.name</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.description</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.is_public</td>
|
||
<td>bool</td>
|
||
<td>通知主体的迁移项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>通知主体的迁移项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.owner.type</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.owner.name</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.owner.login</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.user.id</td>
|
||
<td>int</td>
|
||
<td>通知主体的迁移创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.user.type</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.user.name</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.user.login</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied.user.image_url</td>
|
||
<td>string</td>
|
||
<td>通知主体的迁移创建者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_user.id</td>
|
||
<td>int</td>
|
||
<td>通知发起者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_user.type</td>
|
||
<td>string</td>
|
||
<td>通知发起者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_user.name</td>
|
||
<td>string</td>
|
||
<td>通知发起者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_user.login</td>
|
||
<td>string</td>
|
||
<td>通知发起者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_user.image_url</td>
|
||
<td>string</td>
|
||
<td>通知发起者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_type</td>
|
||
<td>string</td>
|
||
<td>通知类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>通知内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>viewed</td>
|
||
<td>string</td>
|
||
<td>是否已读，waiting:未读,viewed:已读</td>
|
||
</tr>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>string</td>
|
||
<td>通知状态, canceled:已取消,common: 正常,successed:成功,failure:失败</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</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">"total_count"</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">"applied_messages"</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">"applied"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"project"</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">74</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hehuisssjssjjsjs"</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">"hehuisssjssjjsjs"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wwww"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">10</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">"testforge1"</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">"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="nl">"user"</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">6</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">"何慧"</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">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/6?t=1622513134"</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">6</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"accepted"</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">"2021-06-09 16:34"</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="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"applied_user"</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">6</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">"何慧"</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">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/6?t=1622513134"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"applied_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AppliedProject"</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">"已通过你加入【hehuisssjssjjsjs】仓库的申请。"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"viewed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"waiting"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"successed"</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">"2021-06-09 16:34"</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="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"applied"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"project"</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">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_repo1"</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">"测试项目啊1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"二十多"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</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">6</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">"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">"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">"owner"</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">9</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">"Organization"</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">"测试组织"</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">"ceshi_org"</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">"images/avatars/Organization/9?t=1612706073"</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">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"common"</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">"2021-04-26 09:54"</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">"35分钟前"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"applied_user"</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">6</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">"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">"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">"applied_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AppliedTransferProject"</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">"正在将【测试项目啊1】仓库转移给【测试组织】"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"viewed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"viewed"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"common"</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">"2021-04-26 09:54"</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">"35分钟前"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="err">...</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='dd01263b80'>待办事项-接受仓库</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/users/yystopf/applied_transfer_projects.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/users/:login/applied_transfer_projects.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-21'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_transfer_projects.json</code></p>
|
||
<h3 id='aa883f5d52-16'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-14'>返回字段说明:</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>status</td>
|
||
<td>string</td>
|
||
<td>迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>迁移创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>迁移项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>迁移项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>迁移项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>迁移项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>迁移项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>迁移创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移创建者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.id</td>
|
||
<td>int</td>
|
||
<td>迁移接受者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.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">"total_count"</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">"applied_transfer_projects"</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">"project"</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">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_repo1"</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">"测试项目啊1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"二十多"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</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">6</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">"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">"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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</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">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canceled"</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">"2021-04-25 18:06"</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">"16小时前"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="err">...</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='db5a40a55d'>用户接受迁移</h2>
|
||
<p>用户接受迁移</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/applied_transfer_projects/2/accept.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/users/:login/applied_transfer_projects/:id/accept.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-22'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_transfer_projects/:id/accept.json</code></p>
|
||
<h3 id='aa883f5d52-17'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>int</td>
|
||
<td>迁移id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-15'>返回字段说明:</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>status</td>
|
||
<td>string</td>
|
||
<td>迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>迁移创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>迁移项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>迁移项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>迁移项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>迁移项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>迁移项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>迁移创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移创建者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.id</td>
|
||
<td>int</td>
|
||
<td>迁移接受者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.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">"project"</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">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_repo1"</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">"测试项目啊1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"二十多"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</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">6</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">"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">"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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</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">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canceled"</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">"2021-04-25 18:06"</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">"16小时前"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='5e6ed41015'>用户拒绝迁移</h2>
|
||
<p>用户拒绝迁移</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/applied_transfer_projects/2/refuse.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/users/:login/applied_transfer_projects/:id/refuse.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-23'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_transfer_projects/:id/refuse.json</code></p>
|
||
<h3 id='aa883f5d52-18'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>int</td>
|
||
<td>迁移id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-16'>返回字段说明:</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>status</td>
|
||
<td>string</td>
|
||
<td>迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>迁移创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>迁移项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>迁移项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>迁移项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>迁移项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>迁移项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>迁移创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移创建者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.id</td>
|
||
<td>int</td>
|
||
<td>迁移接受者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.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">"project"</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">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_repo1"</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">"测试项目啊1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"二十多"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</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">6</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">"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">"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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</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">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canceled"</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">"2021-04-25 18:06"</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">"16小时前"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='ba97e431b8'>待办事项-项目申请</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/users/yystopf/applied_projects.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/users/:login/applied_projects.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-24'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_projects.json</code></p>
|
||
<h3 id='aa883f5d52-19'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-17'>返回字段说明:</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>status</td>
|
||
<td>string</td>
|
||
<td>申请状态，canceled:取消,common:正在申请, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>申请创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>申请项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>申请项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>申请项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>申请项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>申请项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>申请项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>申请创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>申请创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>申请创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>申请创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.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">"total_count"</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">"applied_transfer_projects"</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">"project"</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">74</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hehuisssjssjjsjs"</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">"hehuisssjssjjsjs"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wwww"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">10</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">"testforge1"</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">"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="nl">"user"</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">6</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">"何慧"</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">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/6?t=1622513134"</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">7</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"common"</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">"2021-06-09 16:41"</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">"7分钟前"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="err">...</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='e8ec937c34'>用户接受申请</h2>
|
||
<p>用户接受申请</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/applied_projects/2/accept.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/users/:login/applied_projects/:id/accept.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-25'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_projects/:id/accept.json</code></p>
|
||
<h3 id='aa883f5d52-20'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>int</td>
|
||
<td>申请id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-18'>返回字段说明:</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>status</td>
|
||
<td>string</td>
|
||
<td>申请状态，canceled:取消,common:正在申请, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>申请创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>申请项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>申请项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>申请项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>申请项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>申请项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>申请项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>申请创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>申请创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>申请创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>申请创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.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">"project"</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">74</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hehuisssjssjjsjs"</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">"hehuisssjssjjsjs"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wwww"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">10</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">"testforge1"</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">"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="nl">"user"</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">6</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">"何慧"</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">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/6?t=1622513134"</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">7</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"accept"</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">"2021-06-09 16:41"</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">"7分钟前"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='f2ee84ecf7'>用户拒绝申请</h2>
|
||
<p>用户拒绝申请</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/users/yystopf/applied_projects/2/refuse.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/users/:login/applied_projects/:id/refuse.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-26'>HTTP 请求</h3>
|
||
<p><code>GET /api/users/:login/applied_projects/:id/refuse.json</code></p>
|
||
<h3 id='aa883f5d52-21'>请求字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>login</td>
|
||
<td>string</td>
|
||
<td>用户标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>int</td>
|
||
<td>申请id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-19'>返回字段说明:</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>status</td>
|
||
<td>string</td>
|
||
<td>申请状态，canceled:取消,common:正在申请, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>申请创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>申请项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>申请项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>申请项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>申请项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>申请项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>申请项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>申请创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>申请创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>申请创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>申请创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.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">"project"</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">74</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hehuisssjssjjsjs"</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">"hehuisssjssjjsjs"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wwww"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">10</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">"testforge1"</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">"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="nl">"user"</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">6</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">"何慧"</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">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/6?t=1622513134"</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">7</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"accept"</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">"2021-06-09 16:41"</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">"7分钟前"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h1 id='projects'>Projects</h1><h2 id='ac55469b06'>申请加入项目</h2>
|
||
<p>申请加入项目</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/applied_projects.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/appliedr_projects.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||
<p><code>POST /api/applied_projects.json</code></p>
|
||
<h3 id='1f9ac54b15'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>applied_project.code</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>邀请码</td>
|
||
</tr>
|
||
<tr>
|
||
<td>applied_project.role</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目权限，reporter: 报告者, developer: 开发者，manager：管理员</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">"applied_project"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1una34"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"role"</span><span class="p">:</span><span class="w"> </span><span class="s2">"developer"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h3 id='b302a98fa6'>返回字段说明</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>status</td>
|
||
<td>string</td>
|
||
<td>申请状态，canceled:取消,common:正在申请, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>项目申请创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>申请项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>申请项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>申请项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>申请项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>申请项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>申请项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>申请项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>申请创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>申请创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>申请创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>申请创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.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">"project"</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">74</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"hehuisssjssjjsjs"</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">"hehuisssjssjjsjs"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wwww"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">10</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">"testforge1"</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">"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="nl">"user"</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">6</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">"何慧"</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">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/6?t=1622513134"</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">7</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"common"</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">"2021-06-09 16:41"</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="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='bfdfb34952'>获取项目列表</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">"page=1"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"limit=5"</span> <span class="se">\</span>
|
||
http://localhost:3000/api/projects | jq
|
||
</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/projects</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-2'>HTTP 请求</h3>
|
||
<p><code>GET api/projects</code></p>
|
||
<h3 id='1f9ac54b15-2'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>page</td>
|
||
<td>false</td>
|
||
<td>1</td>
|
||
<td>string</td>
|
||
<td>页数，第几页</td>
|
||
</tr>
|
||
<tr>
|
||
<td>limit</td>
|
||
<td>false</td>
|
||
<td>15</td>
|
||
<td>string</td>
|
||
<td>每页多少条数据，默认15条</td>
|
||
</tr>
|
||
<tr>
|
||
<td>sort_by</td>
|
||
<td>false</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>排序类型, 取值：updated_on、created_on、forked_count、praises_count; updated_on: 更新时间排序，created_on: 创建时间排序，forked_count: fork数据排序，praises_count: 点赞数量排序，默认为updated_on更新时间排序</td>
|
||
</tr>
|
||
<tr>
|
||
<td>sort_direction</td>
|
||
<td>false</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>排序方式,取值为: desc、asc; desc: 降序排序， asc: 升序排序， 默认为：desc</td>
|
||
</tr>
|
||
<tr>
|
||
<td>search</td>
|
||
<td>false</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>按照项目名称搜索</td>
|
||
</tr>
|
||
<tr>
|
||
<td>category_id</td>
|
||
<td>false</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目类别id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>language_id</td>
|
||
<td>false</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_type</td>
|
||
<td>false</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目类型， 取值为：common、mirror; common:开源托管项目, mirror:开源镜像项目</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-2'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>项目总条数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>string</td>
|
||
<td>项目id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>项目简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>visits</td>
|
||
<td>int</td>
|
||
<td>流量数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>forked_count</td>
|
||
<td>int</td>
|
||
<td>被fork的数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>praises_count</td>
|
||
<td>int</td>
|
||
<td>star数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_public</td>
|
||
<td>boolean</td>
|
||
<td>是否公开， true:公开，false:未公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>mirror_url</td>
|
||
<td>string</td>
|
||
<td>镜像url</td>
|
||
</tr>
|
||
<tr>
|
||
<td>last_update_time</td>
|
||
<td>int</td>
|
||
<td>最后更新时间，为UNIX格式的时间戳</td>
|
||
</tr>
|
||
<tr>
|
||
<td>author</td>
|
||
<td>object</td>
|
||
<td>项目创建者</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>用户名，也是用户标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>category</td>
|
||
<td>object</td>
|
||
<td>项目类别</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- id</td>
|
||
<td>int</td>
|
||
<td>项目类型id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>项目类型名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>language</td>
|
||
<td>object</td>
|
||
<td>项目语言</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- id</td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</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">"total_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">3096</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"projects"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1400794</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1402452</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cscw_2021_sponsor"</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">"Sponsor机制下的开源贡献"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CSCW 2021 sponsor机制研究"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"visits"</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">"praises_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">"forked_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">"is_public"</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">"mirror_url"</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">"type"</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">"last_update_time"</span><span class="p">:</span><span class="w"> </span><span class="mi">1611971671</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">"2天前"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"forked_from_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">"open_devops"</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">"platform"</span><span class="p">:</span><span class="w"> </span><span class="s2">"forge"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"张迅晖"</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">"Nigel"</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">"images/avatars/User/3675?t=1611832880"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"category"</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">13</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">"云计算和大数据"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"language"</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">34</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">"Python3.6"</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">
|
||
Remember — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<h2 id='43137706c6'>推荐项目</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>
|
||
http://localhost:3000/api/projects/recommend | jq
|
||
</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/projects/recommend.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-3'>HTTP 请求</h3>
|
||
<p><code>GET api/projects/recommend</code></p>
|
||
<h3 id='b302a98fa6-3'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>项目总条数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>string</td>
|
||
<td>项目id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>项目简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>visits</td>
|
||
<td>int</td>
|
||
<td>流量数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>forked_count</td>
|
||
<td>int</td>
|
||
<td>被fork的数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>praises_count</td>
|
||
<td>int</td>
|
||
<td>star数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_public</td>
|
||
<td>boolean</td>
|
||
<td>是否公开， true:公开，false:未公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>mirror_url</td>
|
||
<td>string</td>
|
||
<td>镜像url</td>
|
||
</tr>
|
||
<tr>
|
||
<td>last_update_time</td>
|
||
<td>int</td>
|
||
<td>最后更新时间，为UNIX格式的时间戳</td>
|
||
</tr>
|
||
<tr>
|
||
<td>author</td>
|
||
<td>object</td>
|
||
<td>项目创建者</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>用户名，也是用户标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>category</td>
|
||
<td>object</td>
|
||
<td>项目类别</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- id</td>
|
||
<td>int</td>
|
||
<td>项目类型id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>项目类型名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>language</td>
|
||
<td>object</td>
|
||
<td>项目语言</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- id</td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</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="p">{</span><span class="w">
|
||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PNAekinmH"</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">"FNILL"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"visits"</span><span class="p">:</span><span class="w"> </span><span class="mi">13567</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"王一达"</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">"wangyida"</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">"avatars/User/b"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"category"</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">8</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">"其他"</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">
|
||
Remember — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<h2 id='42ee1e960d'>项目导航</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>
|
||
http://localhost:3000/api/yystopf/ceshi/menu_list | jq
|
||
</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/menu_list</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-4'>HTTP 请求</h3>
|
||
<p><code>GET api/:owner/:repo/menu_list</code></p>
|
||
<h3 id='1f9ac54b15-3'>请求参数</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>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-4'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>menu_name</td>
|
||
<td>string</td>
|
||
<td>导航名称， home:主页,code:代码库,issues:疑修,pulls:合并请求,devops:工作流,versions:里程碑,activity:动态,setting:仓库设置</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">"menu_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"home"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"menu_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"code"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"menu_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pulls"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"menu_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"activity"</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='144f9deebe'>项目主页</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>
|
||
http://localhost:3000/api/jasder/forgeplus/about | jq
|
||
</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/forgeplus/about</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-5'>HTTP 请求</h3>
|
||
<p><code>GET api/:owner/:repo/about</code></p>
|
||
<h3 id='1f9ac54b15-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>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-5'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>identifier</td>
|
||
<td>string</td>
|
||
<td>project's identifier</td>
|
||
</tr>
|
||
<tr>
|
||
<td>content</td>
|
||
<td>string</td>
|
||
<td>主页内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>attachments</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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"forgeplus"</span><span class="p">,</span><span class="w">
|
||
</span><span class="err">attachments:</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">
|
||
Remember — a happy kitten is an authenticated kitten!
|
||
</aside>
|
||
<h2 id='d088903907'>项目模块信息</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>
|
||
http://localhost:3000/api/yystopf/ceshi/project_units.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/project_units</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-6'>HTTP 请求</h3>
|
||
<p><code>GET /api/yystopf/ceshi/project_units</code></p>
|
||
<h3 id='7447e4874e'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>type</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="p">{</span><span class="w">
|
||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"code"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</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">"pulls"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</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">"issues"</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='ed3c54441c'>更改项目模块展示</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>
|
||
<span class="nt">-H</span> <span class="s2">"accept: application/json"</span> <span class="se">\</span>
|
||
<span class="nt">-H</span> <span class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"{ </span><span class="se">\"</span><span class="s2">unit_typs</span><span class="se">\"</span><span class="s2">: [</span><span class="se">\"</span><span class="s2">code</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">pulls</span><span class="se">\"</span><span class="s2">]}"</span> <span class="se">\</span>
|
||
http://localhost:3000/api/yystopf/ceshi/project_units.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/project_units</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-7'>HTTP 请求</h3>
|
||
<p><code>POST /api/yystopf/ceshi/project_units</code></p>
|
||
<h3 id='1f9ac54b15-5'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>unit_types</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>array</td>
|
||
<td>项目模块内容， 支持以下参数:code:代码库,issues:疑修,pulls:合并请求,devops:工作流,versions:里程碑</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-2'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>返回状态， 0: 表示操作成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>message</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='80f5dfd187'>创建项目</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>
|
||
<span class="nt">-d</span> <span class="s2">"user_id=36401"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"name=hnfl_demo"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"description=my first project"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"repository_name=hnfl_demo"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"project_category_id=1"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"project_language_id=2"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"ignore_id=2"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"license_id=1"</span> <span class="se">\</span>
|
||
http://localhost:3000/api/projects.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/projects.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-8'>HTTP 请求</h3>
|
||
<p><code>POST api/projects</code></p>
|
||
<h3 id='1f9ac54b15-6'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>user_id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>用户id或者组织id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repository_name</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_category_id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目类别id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_language_id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ignore_id</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>gitignore相关id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>license_id</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>开源许可证id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>private</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>boolean</td>
|
||
<td>项目是否私有, true：为私有，false: 公开，默认为公开</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-6'>返回字段说明</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>
|
||
</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">3240</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">"好项目"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='2396d2124e'>创建镜像项目</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>
|
||
<span class="nt">-d</span> <span class="s2">"user_id=36408"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"clone_addr=https://gitea.com/mx8090alex/golden.git"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"name=golden_mirror1"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"description=golden_mirror"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"project_category_id=1"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"project_language_id=2"</span> <span class="se">\</span>
|
||
http://localhost:3000/api/projects/migrate.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/projects/migrate.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-9'>HTTP 请求</h3>
|
||
<p><code>POST api/projects/migrate.json</code></p>
|
||
<h3 id='1f9ac54b15-7'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>user_id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>用户id或者组织id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>clone_addr</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>镜像项目clone地址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repository_name</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>仓库名称, 只含有数字、字母、下划线不能以下划线开头和结尾，且唯一</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_category_id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目类别id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_language_id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_mirror</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>boolean</td>
|
||
<td>是否设置为镜像， true：是， false：否，默认为否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>auth_username</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>镜像源仓库的登录用户名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>auth_password</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>镜像源仓库的登录秘密</td>
|
||
</tr>
|
||
<tr>
|
||
<td>private</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>boolean</td>
|
||
<td>项目是否私有, true：为私有，false: 非私有，默认为公开</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-7'>返回字段说明</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>
|
||
</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">3241</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">"这是一个镜像项目"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='1940f9da56'>同步镜像</h2>
|
||
<p>手动同步镜像</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/repositories/1244/sync_mirror.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/repositories/1244/sync_mirror.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-10'>HTTP 请求</h3>
|
||
<p><code>POST api/repositories/:id/sync_mirror.json</code></p>
|
||
<h3 id='1f9ac54b15-8'>请求参数</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>必选</th>
|
||
<th>默认</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>仓库id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-8'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>状态码， 0:标识请求成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>message</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='fork'>Fork项目</h2>
|
||
<p>fork项目</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/jasder/forgeplus/forks.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/jaser/jasder_test/forks.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-11'>HTTP 请求</h3>
|
||
<p><code>POST api/:owner/:repo/forks.json</code></p>
|
||
<h3 id='1f9ac54b15-9'>请求参数</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>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-9'>返回字段说明</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>identifier</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">3290</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"newadm"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='da9d632a06'>用户管理的组织列表</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>
|
||
http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizations.json | jq
|
||
</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/:owner/:repo/applied_transfer_projects/organizations</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-12'>HTTP 请求</h3>
|
||
<p><code>GET api/:owner/:repo/applied_transfer_projects/organizations</code></p>
|
||
<h3 id='1f9ac54b15-10'>请求参数</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>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-10'>返回字段说明</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>组织标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>nickname</td>
|
||
<td>string</td>
|
||
<td>组织名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>组织描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>avatar_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">"total_count"</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">"organizations"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">9</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">"ceshi_org"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"测试组织"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"测试组织"</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">"images/avatars/Organization/9?t=1612706073"</span><span class="w">
|
||
</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">51</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">"ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"测试组织哈哈哈"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"23212312"</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">"images/avatars/Organization/51?t=1618800723"</span><span class="w">
|
||
</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">52</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">"ceshi1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"nickname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"身份卡手动阀"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1231手动阀是的"</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">"images/avatars/Organization/52?t=1618805056"</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='ac41ac8cdc'>迁移项目</h2>
|
||
<p>迁移项目，edit接口is_transfering为true表示正在迁移</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects.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/:owner/:repo/applied_transfer_projects.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-13'>HTTP 请求</h3>
|
||
<p><code>POST /api/:owner/:repo/applied_transfer_projects.json</code></p>
|
||
<h3 id='1f9ac54b15-11'>请求参数</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>owner_name</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>迁移对象标识</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-11'>返回字段说明</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>status</td>
|
||
<td>string</td>
|
||
<td>项目迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>项目迁移创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>迁移项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>迁移项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>迁移项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>迁移项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>迁移项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>迁移创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移创建者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.id</td>
|
||
<td>int</td>
|
||
<td>迁移接受者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.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">"project"</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">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_repo1"</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">"测试项目啊1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"二十多"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</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">6</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">"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">"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">"owner"</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">9</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">"Organization"</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">"测试组织"</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">"ceshi_org"</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">"images/avatars/Organization/9?t=1612706073"</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">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"common"</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">"2021-04-26 09:54"</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="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='4f8579f6bd'>取消迁移项目</h2>
|
||
<p>迁移项目，edit接口is_transfering为true表示正在迁移</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/cancel.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/:owner/:repo/applied_transfer_projects/cancel.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-14'>HTTP 请求</h3>
|
||
<p><code>POST /api/:owner/:repo/applied_transfer_projects/cancel.json</code></p>
|
||
<h3 id='1f9ac54b15-12'>请求参数</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>
|
||
</tbody></table>
|
||
<h3 id='b302a98fa6-12'>返回字段说明</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>status</td>
|
||
<td>string</td>
|
||
<td>迁移状态，canceled:取消,common:正在迁移, accept:已接受,refuse:已拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>time_ago</td>
|
||
<td>string</td>
|
||
<td>迁移创建的时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.id</td>
|
||
<td>int</td>
|
||
<td>迁移项目的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.identifier</td>
|
||
<td>string</td>
|
||
<td>迁移项目的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.description</td>
|
||
<td>string</td>
|
||
<td>迁移项目的描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.is_public</td>
|
||
<td>bool</td>
|
||
<td>迁移项目是否公开</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.id</td>
|
||
<td>bool</td>
|
||
<td>迁移项目拥有者id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者昵称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project.owner.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移项目拥有者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.id</td>
|
||
<td>int</td>
|
||
<td>迁移创建者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.type</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.name</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.login</td>
|
||
<td>string</td>
|
||
<td>迁移创建者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>user.image_url</td>
|
||
<td>string</td>
|
||
<td>迁移创建者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.id</td>
|
||
<td>int</td>
|
||
<td>迁移接受者的id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.type</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.name</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.login</td>
|
||
<td>string</td>
|
||
<td>迁移接受者的标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>owner.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">"project"</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">86</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_repo1"</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">"测试项目啊1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"二十多"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"owner"</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">52</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">"Organization"</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">"身份卡手动阀"</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">"ceshi1"</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">"images/avatars/Organization/52?t=1618805056"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"user"</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">6</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">"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">"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">"owner"</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">9</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">"Organization"</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">"测试组织"</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">"ceshi_org"</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">"images/avatars/Organization/9?t=1612706073"</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">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"common"</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">"2021-04-26 09:54"</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="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h1 id='repositories'>Repositories</h1><h2 id='0a366f0c25'>仓库详情</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/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">GET /api/jasder/jasder_test.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo</code></p>
|
||
<h3 id='2eb6f47757'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e'>返回字段说明:</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>identifier</td>
|
||
<td>string</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_public</td>
|
||
<td>boolean</td>
|
||
<td>项目是否公开， true:公开，false:私有</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>项目简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo_id</td>
|
||
<td>int</td>
|
||
<td>仓库id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo_identifier</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ni项目"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mirror_demo"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my first project mirror_demo"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">75073</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mirror_demo"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='32bf9fcdcf'>仓库详情(简版)</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/jasder/jasder_test/simple.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/simple.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-2'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/simple</code></p>
|
||
<h3 id='2eb6f47757-2'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-2'>返回字段说明:</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>identifier</td>
|
||
<td>string</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_public</td>
|
||
<td>boolean</td>
|
||
<td>项目是否公开， true:公开，false:私有</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>项目简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo_id</td>
|
||
<td>int</td>
|
||
<td>仓库id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo_identifier</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ni项目"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mirror_demo"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my first project mirror_demo"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">75073</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mirror_demo"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='ba8983357c'>仓库详情(新版)</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/ceshi/detail.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/detail.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-3'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/detail</code></p>
|
||
<h3 id='2eb6f47757-3'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-3'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>content</td>
|
||
<td>string</td>
|
||
<td>仓库简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>website</td>
|
||
<td>string</td>
|
||
<td>仓库网址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>readme</td>
|
||
<td>string</td>
|
||
<td>readme文件｜</td>
|
||
</tr>
|
||
<tr>
|
||
<td>identifier</td>
|
||
<td>string</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issues_count</td>
|
||
<td>int</td>
|
||
<td>项目issue数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_requests_count</td>
|
||
<td>int</td>
|
||
<td>项目合并请求数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_identifier</td>
|
||
<td>int</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>praises_count</td>
|
||
<td>int</td>
|
||
<td>项目点赞数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>forked_count</td>
|
||
<td>int</td>
|
||
<td>项目复刻数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>watchers_count</td>
|
||
<td>int</td>
|
||
<td>项目关注数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>versions_count</td>
|
||
<td>int</td>
|
||
<td>项目里程碑数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>version_releases_count</td>
|
||
<td>int</td>
|
||
<td>项目发行版数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>version_releasesed_count</td>
|
||
<td>int</td>
|
||
<td>项目发行版已发行数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>permission</td>
|
||
<td>string</td>
|
||
<td>项目权限</td>
|
||
</tr>
|
||
<tr>
|
||
<td>mirror_url</td>
|
||
<td>string</td>
|
||
<td>镜像地址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>mirror</td>
|
||
<td>bool</td>
|
||
<td>是否为镜像项目</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>int</td>
|
||
<td>项目类型 0 普通项目 1 普通镜像项目 2 同步镜像项目</td>
|
||
</tr>
|
||
<tr>
|
||
<td>open_devops</td>
|
||
<td>int</td>
|
||
<td>是否开启devops</td>
|
||
</tr>
|
||
<tr>
|
||
<td>watched</td>
|
||
<td>bool</td>
|
||
<td>是否关注</td>
|
||
</tr>
|
||
<tr>
|
||
<td>praised</td>
|
||
<td>bool</td>
|
||
<td>是否点赞</td>
|
||
</tr>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>项目状态</td>
|
||
</tr>
|
||
<tr>
|
||
<td>forked_from_project_id</td>
|
||
<td>int</td>
|
||
<td>fork项目id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>fork_info</td>
|
||
<td>object</td>
|
||
<td>fork项目信息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>size</td>
|
||
<td>string</td>
|
||
<td>仓库大小</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ssh_url</td>
|
||
<td>string</td>
|
||
<td>项目ssh地址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>clone_url</td>
|
||
<td>string</td>
|
||
<td>项目克隆地址</td>
|
||
</tr>
|
||
<tr>
|
||
<td>default_branch</td>
|
||
<td>string</td>
|
||
<td>仓库默认分支</td>
|
||
</tr>
|
||
<tr>
|
||
<td>empty</td>
|
||
<td>bool</td>
|
||
<td>仓库是否为空</td>
|
||
</tr>
|
||
<tr>
|
||
<td>full_name</td>
|
||
<td>string</td>
|
||
<td>仓库全称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>private</td>
|
||
<td>bool</td>
|
||
<td>仓库是否为私有项目</td>
|
||
</tr>
|
||
<tr>
|
||
<td>license_name</td>
|
||
<td>string</td>
|
||
<td>许可证名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release_versions.list.name</td>
|
||
<td>string</td>
|
||
<td>项目issue数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release_versions.list.tag_name</td>
|
||
<td>string</td>
|
||
<td>发行版标签名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release_versions.list.created_at</td>
|
||
<td>string</td>
|
||
<td>发行版创建时间</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release_versions.total_count</td>
|
||
<td>int</td>
|
||
<td>发行版数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>branches.list.name</td>
|
||
<td>string</td>
|
||
<td>分支名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>branches.total_count</td>
|
||
<td>int</td>
|
||
<td>分支数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>tags.list.name</td>
|
||
<td>string</td>
|
||
<td>标签名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>tags.total_count</td>
|
||
<td>int</td>
|
||
<td>标签数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>contributors.list.contributions</td>
|
||
<td>int</td>
|
||
<td>贡献数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>contributors.list.login</td>
|
||
<td>string</td>
|
||
<td>贡献者登录名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>contributors.list.name</td>
|
||
<td>string</td>
|
||
<td>贡献者用户名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>contributors.list.image_url</td>
|
||
<td>string</td>
|
||
<td>贡献者头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>languages</td>
|
||
<td>object</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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"仓库简介"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"website"</span><span class="p">:</span><span class="w"> </span><span class="s2">"仓库网址"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"readme"</span><span class="p">:</span><span class="w"> </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">"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">9</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">"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">"# ceshi</span><span class="se">\n\n</span><span class="s2">"</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">""</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi"</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">"测试项目"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"repo_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"issues_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">"pull_requests_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">"project_identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"praises_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">"forked_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">"watchers_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">"versions_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">"version_releases_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">"version_releasesed_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">"permission"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Reporter"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"mirror_url"</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">"mirror"</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">"type"</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">"open_devops"</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">"watched"</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">"praised"</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">"status"</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">"forked_from_project_id"</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">"fork_info"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"fork_form_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"测试项目"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"fork_project_user_login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_org"</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="s2">"ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"fork_project_user_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi_org"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"size"</span><span class="p">:</span><span class="w"> </span><span class="s2">"25.0 KB"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"ssh_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"virus@localhost:yystopf/ceshi.git"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"clone_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshi.git"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"default_branch"</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">"empty"</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">"full_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf/ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"private"</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">"license_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gnu-javamail-exception"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"release_versions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"list"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"vvvv"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"tag_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"v1.1"</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">"2019-07-18 10:16"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"branches"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"list"</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">"master"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"list"</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.1"</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"</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><span class="nl">"contributors"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"list"</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">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"gid"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"avatars/User/b"</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">1</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"languages"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"HTML"</span><span class="p">:</span><span class="w"> </span><span class="s2">"50.9%"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Ruby"</span><span class="p">:</span><span class="w"> </span><span class="s2">"25.6%"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"JavaScript"</span><span class="p">:</span><span class="w"> </span><span class="s2">"21.4%"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"CSS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.3%"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"CoffeeScript"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.7%"</span><span class="p">,</span><span class="w">
|
||
</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>
|
||
|
||
<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/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-5'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/edit.json</code></p>
|
||
<h3 id='2eb6f47757-5'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-5'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>identifier</td>
|
||
<td>string</td>
|
||
<td>仓库标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_id</td>
|
||
<td>int</td>
|
||
<td>项目id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_name</td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_identifier</td>
|
||
<td>string</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_description</td>
|
||
<td>string</td>
|
||
<td>项目简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_category_id</td>
|
||
<td>int</td>
|
||
<td>项目类别id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_language_id</td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>private</td>
|
||
<td>boolean</td>
|
||
<td>项目是否私有, true：为私有，false: 公开</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">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"project"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">3263</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"项目"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"project identifier"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"project description"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_category_id"</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">"project_language_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"private"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='3c8c437c47'>修改仓库信息</h2>
|
||
<p>修改仓库信息</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>
|
||
<span class="nt">-d</span> <span class="s2">"name=hnfl_demo"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"description=my first project"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"project_category_id=1"</span> <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"project_language_id=2"</span> <span class="se">\</span>
|
||
<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-6'>HTTP 请求</h3>
|
||
<p><code>PATCH /api/:owner/:repo</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>id</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>项目描述</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_category_id</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目类别id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_language_id</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>default_branch</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>默认分支名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>private</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>boolean</td>
|
||
<td>项目是否私有, true：为私有，false: 公开，默认为公开</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-6'>返回字段说明:</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>identifier</td>
|
||
<td>string</td>
|
||
<td>项目标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>项目名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>description</td>
|
||
<td>string</td>
|
||
<td>项目简介</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_category_id</td>
|
||
<td>int</td>
|
||
<td>项目类别id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>project_language_id</td>
|
||
<td>int</td>
|
||
<td>项目语言id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>private</td>
|
||
<td>否</td>
|
||
<td>boolean</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">3263</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"project identifier"</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">"project name"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"project description"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_category_id"</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">"project_language_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_public"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='34ae800a2c'>删除仓库</h2>
|
||
<p>删除仓库</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</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-7'>HTTP 请求</h3>
|
||
<p><code>PATCH /api/:owner/:repo</code></p>
|
||
<h3 id='2eb6f47757-7'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-7'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>返回状态， 0: 表示操作成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>message</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="warning">
|
||
只有平台管理员和项目管理员才能删除仓库.
|
||
</aside>
|
||
<h2 id='8801e8fd87'>添加仓库成员</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>
|
||
<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-8'>HTTP 请求</h3>
|
||
<p><code>POST /api/:owner/:repo/collaborators.json</code></p>
|
||
<h3 id='2eb6f47757-8'>请求参数:</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>user_id</td>
|
||
<td>是</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
<td>用户id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-8'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>返回状态， 0: 表示操作成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>message</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="warning">
|
||
只有平台管理员和项目管理员才能添加仓库成员.
|
||
</aside>
|
||
<h2 id='c25af9423c'>删除仓库成员</h2>
|
||
<p>仓库中删除成员操作</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> DELETE <span class="se">\</span>
|
||
<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-9'>HTTP 请求</h3>
|
||
<p><code>DELETE /api/:owner/:repo/collaborators.json</code></p>
|
||
<h3 id='2eb6f47757-9'>请求参数:</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>user_id</td>
|
||
<td>是</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
<td>用户id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-9'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>返回状态， 0: 表示操作成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>message</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="warning">
|
||
只有平台管理员和项目管理员才能删除仓库成员.
|
||
</aside>
|
||
<h2 id='d4fbcddc09'>更改仓库成员角色(权限)</h2>
|
||
<p>更改仓库成员角色</p>
|
||
|
||
<blockquote>
|
||
<p>示例:</p>
|
||
</blockquote>
|
||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> PUT <span class="se">\</span>
|
||
<span class="nt">-d</span> <span class="s2">"user_id=12"</span> <span class="se">\</span>
|
||
<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-10'>HTTP 请求</h3>
|
||
<p><code>PUT /api/:owner/:repo/change_role.json</code></p>
|
||
<h3 id='2eb6f47757-10'>请求参数:</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>user_id</td>
|
||
<td>是</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
<td>用户id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>role</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td></td>
|
||
<td>取值范围："Manager", "Developer", "Reporter"；分别为项目管理人员(拥有所有操作权限)、项目开发人员(只拥有读写权限)、项目报告人员(只拥有读权限)</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-10'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>int</td>
|
||
<td>返回状态， 0: 表示操作成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>message</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">"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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="warning">
|
||
只有平台管理员和项目管理员才能更改仓库成员角色.
|
||
</aside>
|
||
<h2 id='1091eafea0'>获取仓库成员列表</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">"page=1"</span> <span class="se">\</span>
|
||
<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-11'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/collaborators.json</code></p>
|
||
<h3 id='2eb6f47757-11'>请求参数:</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></td>
|
||
<td>string</td>
|
||
<td>页数，第几页</td>
|
||
</tr>
|
||
<tr>
|
||
<td>limit</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>每页多少条数据，默认15条</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-11'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>total_count</td>
|
||
<td>int</td>
|
||
<td>返回记录总条数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>members</td>
|
||
<td>array</td>
|
||
<td>项目成员信息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- id</td>
|
||
<td>int</td>
|
||
<td>用户id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>用户名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- login</td>
|
||
<td>string</td>
|
||
<td>用户登录名/标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- image_url</td>
|
||
<td>string</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- is_owner</td>
|
||
<td>boolean</td>
|
||
<td>是否是项目的拥有者，true:是， false:不是</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- role</td>
|
||
<td>string</td>
|
||
<td>该用户在项目中的角色， Manager: 管理员(拥有操作权限); Developer:开发人员(只拥有读写权限)； Reporter:报告人员(只拥有读权限)</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">"total_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"members"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">36401</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">"name"</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">"login"</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">"avatars/User/b"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_owner"</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">"role"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Manager"</span><span class="w">
|
||
</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">36399</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">"name"</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">"login"</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">"avatars/User/b"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_owner"</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">"role"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Developer"</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='59943eacca'>获取仓库所有文件</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=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-12'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/files</code></p>
|
||
<h3 id='2eb6f47757-12'>请求参数:</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>search</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>文件搜索关键词</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ref</td>
|
||
<td>是</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>分支名，默认为仓库默认分支</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-12'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>文件名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>path</td>
|
||
<td>string</td>
|
||
<td>文件路径</td>
|
||
</tr>
|
||
<tr>
|
||
<td>sha</td>
|
||
<td>string</td>
|
||
<td>文件标识</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>文件类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>size</td>
|
||
<td>int</td>
|
||
<td>文件大小</td>
|
||
</tr>
|
||
<tr>
|
||
<td>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="p">{</span><span class="w">
|
||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">".gitignore"</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">".gitignore"</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">"f83922d01ae60f6e637a1a2b9f08871b4f87dfc8"</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">"file"</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">63</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:10080/api/v1/repos/yystopf/ceshi/contents/.gitignore?ref=master"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"html_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshi/src/branch/master/.gitignore"</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">"LICENSE"</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">"LICENSE"</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">"8f3b9ab0d08afd3a624d822e3971a2f42b3bc2b9"</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">"file"</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">341</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:10080/api/v1/repos/yystopf/ceshi/contents/LICENSE?ref=master"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"html_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshi/src/branch/master/LICENSE"</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">"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">"README.md"</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">"1bc8a60ac6ddc876ebc4b60fc68991435bfad93e"</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">"file"</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">9</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:10080/api/v1/repos/yystopf/ceshi/contents/README.md?ref=master"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"html_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10080/yystopf/ceshi/src/branch/master/README.md"</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='0c98b4c01b'>获取仓库代码目录</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=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-13'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/entries.json</code></p>
|
||
<h3 id='2eb6f47757-13'>请求参数:</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，默认为master分支</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-13'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>last_commit</td>
|
||
<td>object</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- commit</td>
|
||
<td>object</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>int</td>
|
||
<td>id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>name</td>
|
||
<td>string</td>
|
||
<td>文件夹或文件名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>path</td>
|
||
<td>string</td>
|
||
<td>文件夹或文件相对路径</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>文件类型， file:文件，dir：文件目录</td>
|
||
</tr>
|
||
<tr>
|
||
<td>size</td>
|
||
<td>int</td>
|
||
<td>文件夹或文件大小 单位B</td>
|
||
</tr>
|
||
<tr>
|
||
<td>content</td>
|
||
<td>string</td>
|
||
<td>文件内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>target</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">"last_commit"</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">"3f2de4f78d2d7050486535082cd11cdfc9f3679e"</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:3003//api/repositories/api-cloud-platform/commits/3f2de4f78d2d7050486535082cd11cdfc9f3679e"</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">"update README.md."</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gitee"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"noreply@gitee.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-02T20:23:18+08:00"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gitee"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"noreply@gitee.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"date"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-02T20:23:18+08:00"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"timestamp"</span><span class="p">:</span><span class="w"> </span><span class="mi">1583151798</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"time_from_now"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3个月前"</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="kc">null</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"committer"</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><span class="nl">"entries"</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">"ace-gate"</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">"ace-gate"</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">"c83f85fc63b14edcd6fc502eee9996f5a9993eca"</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">"dir"</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">0</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"content"</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">"target"</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">"commit"</span><span class="p">:</span><span class="w"> </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">"v2.9 升级alibaba组件release版本</span><span class="se">\n</span><span class="s2">"</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">"6117eaab86f71115f42f2a46ff1683015cda798d"</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">"1970-01-01 08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"time_from_now"</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="kc">null</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='fcc64a694b'>获取仓库代码子目录或者文件</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=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-14'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/sub_entries.json</code></p>
|
||
<h3 id='2eb6f47757-14'>请求参数:</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>filepath</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>文件夹、文件的相对路径</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>ref</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>分支名称、tag名称或是提交记录id，默认为master分支</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-14'>返回字段说明:</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>path</td>
|
||
<td>string</td>
|
||
<td>文件夹或文件相对路径</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>文件类型， file:文件，dir：文件目录</td>
|
||
</tr>
|
||
<tr>
|
||
<td>size</td>
|
||
<td>int</td>
|
||
<td>文件夹或文件大小 单位KB</td>
|
||
</tr>
|
||
<tr>
|
||
<td>content</td>
|
||
<td>string</td>
|
||
<td>文件内容，</td>
|
||
</tr>
|
||
<tr>
|
||
<td>target</td>
|
||
<td>string</td>
|
||
<td>标签</td>
|
||
</tr>
|
||
<tr>
|
||
<td>url</td>
|
||
<td>string</td>
|
||
<td>文件访问链接,带分支</td>
|
||
</tr>
|
||
<tr>
|
||
<td>html_url</td>
|
||
<td>string</td>
|
||
<td>文件访问链接，未标识分支</td>
|
||
</tr>
|
||
<tr>
|
||
<td>git_url</td>
|
||
<td>string</td>
|
||
<td>文件夹或文件的git仓库访问链接</td>
|
||
</tr>
|
||
<tr>
|
||
<td>download_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="p">{</span><span class="w">
|
||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"build.rc"</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/build.rc"</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">""</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">1268</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"content"</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">"target"</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">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3003/api/v1/repos/18816895620/mirror_demo/contents/lib/build.rc?ref=master"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"html_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3003/18816895620/mirror_demo/src/branch/master/lib/build.rc"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"git_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:3003/api/v1/repos/18816895620/mirror_demo/git/blobs/191fcf1a63b3777e2977fcede7dd5309efdd70fe"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"download_url"</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><span class="p">]</span><span class="w">
|
||
</span></code></pre></div>
|
||
<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>
|
||
|
||
<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>
|
||
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-17'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/webhooks.json</code></p>
|
||
<h3 id='2eb6f47757-17'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-17'>返回字段说明:</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>http_method</td>
|
||
<td>string</td>
|
||
<td>请求方式</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>last_status</td>
|
||
<td>string</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">"total_count"</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">"webhooks"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"https://oapi.dingtalk.com/robot/send?access_token=7e1e19d0eddb6a5e33c5c2c4e66f4c88f9437184b9ed2c2653194c6374c7d513"</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">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dingtalk"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"last_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"succeed"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"create_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-12 10:50:07"</span><span class="w">
|
||
</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">3</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:3000"</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">"is_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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gitea"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"last_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"succeed"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"create_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26 10:03:45"</span><span class="w">
|
||
</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">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10081"</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">"POST"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gitea"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"last_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"waiting"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"create_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26 16:56:53"</span><span class="w">
|
||
</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">5</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:3001"</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">"POST"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gitea"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"last_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fail"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"create_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26 16:58: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></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h2 id='webhook'>获取仓库单个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> 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-18'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/webhooks/:id/edit.json</code></p>
|
||
<h3 id='2eb6f47757-18'>请求参数:</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>integer</td>
|
||
<td>webhook ID</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-18'>返回字段说明:</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>http_method</td>
|
||
<td>string</td>
|
||
<td>请求方式</td>
|
||
</tr>
|
||
<tr>
|
||
<td>secret</td>
|
||
<td></td>
|
||
<td>string</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>last_status</td>
|
||
<td>string</td>
|
||
<td>最后一次推送的状态, waiting 等待,fail 失败,succeed 成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>branch_filter</td>
|
||
<td>string</td>
|
||
<td>分支过滤</td>
|
||
</tr>
|
||
<tr>
|
||
<td>events</td>
|
||
<td>string</td>
|
||
<td>触发条件</td>
|
||
</tr>
|
||
<tr>
|
||
<td>create_time</td>
|
||
<td>string</td>
|
||
<td>创建时间</td>
|
||
</tr>
|
||
</tbody></table>
|
||
|
||
<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>fork</td>
|
||
<td>仓库被fork</td>
|
||
</tr>
|
||
<tr>
|
||
<td>push</td>
|
||
<td>git仓库推送</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue</td>
|
||
<td>疑修已打开、已关闭、已重新打开或编辑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_assign</td>
|
||
<td>疑修被指派</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_label</td>
|
||
<td>疑修标签被更新或删除</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_milestone</td>
|
||
<td>疑修被收入里程碑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_comment</td>
|
||
<td>疑修评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request</td>
|
||
<td>合并请求</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_assign</td>
|
||
<td>合并请求被指派</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_label</td>
|
||
<td>合并请求被贴上标签</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_milestone</td>
|
||
<td>合并请求被记录于里程碑中</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_comment</td>
|
||
<td>合并请求被评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_approved</td>
|
||
<td>合并请求被批准</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_rejected</td>
|
||
<td>合并请求被拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_comment</td>
|
||
<td>合并请求被提出审查意见</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_sync</td>
|
||
<td>合并请求被同步</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repository</td>
|
||
<td>创建或删除仓库</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release</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">3</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">"content_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"form"</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:3000"</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">"last_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"succeed"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_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">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gitea"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"create_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26 10:03:45"</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="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">"fork"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"issues"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"issue_assign"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"issue_label"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"issue_milestone"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"issue_comment"</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_label"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"pull_request_milestone"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"pull_request_comment"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"pull_request_review"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"pull_request_sync"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"repository"</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"release"</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='webhook-2'>添加仓库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> 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-19'>HTTP 请求</h3>
|
||
<p><code>POST /api/:owner/:repo/webhooks.json</code></p>
|
||
<h3 id='2eb6f47757-19'>请求参数:</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.type</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>类型</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>fork</td>
|
||
<td>仓库被fork</td>
|
||
</tr>
|
||
<tr>
|
||
<td>push</td>
|
||
<td>git仓库推送</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue</td>
|
||
<td>疑修已打开、已关闭、已重新打开或编辑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_assign</td>
|
||
<td>疑修被指派</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_label</td>
|
||
<td>疑修标签被更新或删除</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_milestone</td>
|
||
<td>疑修被收入里程碑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_comment</td>
|
||
<td>疑修评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request</td>
|
||
<td>合并请求</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_assign</td>
|
||
<td>合并请求被指派</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_label</td>
|
||
<td>合并请求被贴上标签</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_milestone</td>
|
||
<td>合并请求被记录于里程碑中</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_comment</td>
|
||
<td>合并请求被评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_approved</td>
|
||
<td>合并请求被批准</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_rejected</td>
|
||
<td>合并请求被拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_comment</td>
|
||
<td>合并请求被提出审查意见</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_sync</td>
|
||
<td>合并请求被同步</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repository</td>
|
||
<td>创建或删除仓库</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release</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-19'>返回字段说明:</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">18</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">"gitea"</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">"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">"events"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="s2">"push"</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">"create_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26 18:53:43"</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/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-20'>HTTP 请求</h3>
|
||
<p><code>PATCH /api/:owner/:repo/webhooks/:id.json</code></p>
|
||
<h3 id='2eb6f47757-20'>请求参数:</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.type</td>
|
||
<td>否</td>
|
||
<td></td>
|
||
<td>string</td>
|
||
<td>类型</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>fork</td>
|
||
<td>仓库被fork</td>
|
||
</tr>
|
||
<tr>
|
||
<td>push</td>
|
||
<td>git仓库推送</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue</td>
|
||
<td>疑修已打开、已关闭、已重新打开或编辑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_assign</td>
|
||
<td>疑修被指派</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_label</td>
|
||
<td>疑修标签被更新或删除</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_milestone</td>
|
||
<td>疑修被收入里程碑</td>
|
||
</tr>
|
||
<tr>
|
||
<td>issue_comment</td>
|
||
<td>疑修评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request</td>
|
||
<td>合并请求</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_assign</td>
|
||
<td>合并请求被指派</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_label</td>
|
||
<td>合并请求被贴上标签</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_milestone</td>
|
||
<td>合并请求被记录于里程碑中</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_comment</td>
|
||
<td>合并请求被评论</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_approved</td>
|
||
<td>合并请求被批准</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_rejected</td>
|
||
<td>合并请求被拒绝</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_review_comment</td>
|
||
<td>合并请求被提出审查意见</td>
|
||
</tr>
|
||
<tr>
|
||
<td>pull_request_sync</td>
|
||
<td>合并请求被同步</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repository</td>
|
||
<td>创建或删除仓库</td>
|
||
</tr>
|
||
<tr>
|
||
<td>release</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-20'>返回字段说明:</h3>
|
||
<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">"success"</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-4'>删除仓库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> 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-21'>HTTP 请求</h3>
|
||
<p><code>DELETE /api/:owner/:repo/webhooks/:id.json</code></p>
|
||
<h3 id='2eb6f47757-21'>请求参数:</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>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-21'>返回字段说明:</h3>
|
||
<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">"success"</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-5'>获取仓库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> 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-22'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/webhooks/:id/tasks.json</code></p>
|
||
<h3 id='2eb6f47757-22'>请求参数:</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>integer</td>
|
||
<td>webhook ID</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-22'>返回字段说明:</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>uuid</td>
|
||
<td>string</td>
|
||
<td>推送uuid</td>
|
||
</tr>
|
||
<tr>
|
||
<td>type</td>
|
||
<td>string</td>
|
||
<td>类型</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_succeed</td>
|
||
<td>bool</td>
|
||
<td>是否推送成功</td>
|
||
</tr>
|
||
<tr>
|
||
<td>is_delivered</td>
|
||
<td>bool</td>
|
||
<td>是否完成推送</td>
|
||
</tr>
|
||
<tr>
|
||
<td>payload_content</td>
|
||
<td>json</td>
|
||
<td>请求主体内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>request_content</td>
|
||
<td>json</td>
|
||
<td>请求内容，头部等等</td>
|
||
</tr>
|
||
<tr>
|
||
<td>reponse_content</td>
|
||
<td>json</td>
|
||
<td>响应内容，状态，头部，主体等等</td>
|
||
</tr>
|
||
<tr>
|
||
<td>delivered_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">"total_count"</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">"tasks"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</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">"gitea"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"99aa2c23-6884-4c44-9020-5469320aa408"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_succeed"</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">"is_delivered"</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">"payload_content"</span><span class="p">:</span><span class="w"> </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">"ref"</span><span class="p">:</span><span class="w"> </span><span class="s2">"refs/heads/master"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"before"</span><span class="p">:</span><span class="w"> </span><span class="s2">"feb48e31362787a7620b53d4df3c4effddbb6f0b"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"after"</span><span class="p">:</span><span class="w"> </span><span class="s2">"feb48e31362787a7620b53d4df3c4effddbb6f0b"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"compare_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"commits"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"feb48e31362787a7620b53d4df3c4effddbb6f0b"</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">"fix</span><span class="se">\n</span><span class="s2">"</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:10081/yystopf/ceshi/commit/feb48e31362787a7620b53d4df3c4effddbb6f0b"</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">"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">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf@163.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"root"</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">"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">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf@163.com"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"username"</span><span class="p">:</span><span class="w"> </span><span class="s2">"root"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"verification"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"verified"</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">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"gpg.error.not_signed_commit"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"signature"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"signer"</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">"payload"</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="nl">"timestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26T13:52:13+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"added"</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">"removed"</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">"modified"</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><span class="p">],</span><span class="w">
|
||
</span><span class="nl">"head_commit"</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">"repository"</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">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"owner"</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">3</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">"full_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf@forge.com"</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">"http://localhost:10081/user/avatar/yystopf/-1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"language"</span><span class="p">:</span><span class="w"> </span><span class="s2">"zh-CN"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_admin"</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">"last_login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-21T18:38:21+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-06-03T14:50:25+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"username"</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">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"full_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf/ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"empty"</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">"private"</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"</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">"template"</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">"parent"</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">"mirror"</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">"size"</span><span class="p">:</span><span class="w"> </span><span class="mi">3846</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"html_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10081/yystopf/ceshi"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"ssh_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"virus@localhost:10081:yystopf/ceshi.git"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"clone_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"http://localhost:10081/yystopf/ceshi.git"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"original_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"website"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"stars_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">"forks_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">"watchers_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">"open_issues_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">"open_pr_counter"</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">"release_counter"</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">"default_branch"</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">"archived"</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">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-06-03T15:15:30+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-26T13:52:16+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"permissions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"admin"</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">"push"</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">"pull"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"has_issues"</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">"internal_tracker"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"enable_time_tracker"</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">"allow_only_contributors_to_track_time"</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">"enable_issue_dependencies"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"has_wiki"</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">"has_pull_requests"</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">"ignore_whitespace_conflicts"</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">"allow_merge_commits"</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">"allow_rebase"</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">"allow_rebase_explicit"</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">"allow_squash_merge"</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">"avatar_url"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"internal"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"pusher"</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">0</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">"full_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf@forge.com"</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">"http://localhost:10081/user/avatar/yystopf/-1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"language"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_admin"</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">"last_login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0001-01-01T00:00:00Z"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-06-03T14:50:25+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"username"</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">"sender"</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">0</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">"full_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"yystopf@forge.com"</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">"http://localhost:10081/user/avatar/yystopf/-1"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"language"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"is_admin"</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">"last_login"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0001-01-01T00:00:00Z"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"created"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-06-03T14:50:25+08:00"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"username"</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="p">},</span><span class="w">
|
||
</span><span class="nl">"request_content"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"X-GitHub-Delivery"</span><span class="p">:</span><span class="w"> </span><span class="s2">"99aa2c23-6884-4c44-9020-5469320aa408"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-GitHub-Event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"push"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Gitea-Delivery"</span><span class="p">:</span><span class="w"> </span><span class="s2">"99aa2c23-6884-4c44-9020-5469320aa408"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Gitea-Event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"push"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Gitea-Signature"</span><span class="p">:</span><span class="w"> </span><span class="s2">"34a01edcd952ff6410ff6ebc946471161bde74aff86171f21621d2c2c4130f66"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Gogs-Delivery"</span><span class="p">:</span><span class="w"> </span><span class="s2">"99aa2c23-6884-4c44-9020-5469320aa408"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Gogs-Event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"push"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Gogs-Signature"</span><span class="p">:</span><span class="w"> </span><span class="s2">"34a01edcd952ff6410ff6ebc946471161bde74aff86171f21621d2c2c4130f66"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"response_content"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"headers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"Cache-Control"</span><span class="p">:</span><span class="w"> </span><span class="s2">"no-store, must-revalidate, private, max-age=0"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Content-Length"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2556"</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">"text/html; charset=utf-8"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Referrer-Policy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"strict-origin-when-cross-origin"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Set-Cookie"</span><span class="p">:</span><span class="w"> </span><span class="s2">"__profilin=p%3Dt; path=/; HttpOnly"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"Vary"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Origin"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Content-Type-Options"</span><span class="p">:</span><span class="w"> </span><span class="s2">"nosniff"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Download-Options"</span><span class="p">:</span><span class="w"> </span><span class="s2">"noopen"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Frame-Options"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SAMEORIGIN"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Miniprofiler-Ids"</span><span class="p">:</span><span class="w"> </span><span class="s2">"9ynvpncz5xm0rpgorb5y,hgggd9mv6lr4a9drcrlr,j7zqlx2vy5aji2vtgoba,f1ktsmh3jxvq0z2hf612,mih3dvgvlqhi3zy8lf2x,5k1qbkvbnru8mye9cest,tj6ern8w6awqf2zsimbr,9isaehvubivd52wo5p9v,1rzfhtq1nhuwbgy9p76g,z0xzidzyywna0y7a69m0,hzoklky92ycjqt42gi0s,y0ai7y0t28mcn8x0py2x,322il7nadinp51mw2r5m,m6dukftfsh6tjcxzp1gq,667wlqbytfwbrirnmma1,jcehj3dl8lkw8gk510cr"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Miniprofiler-Original-Cache-Control"</span><span class="p">:</span><span class="w"> </span><span class="s2">"max-age=0, private, must-revalidate"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Permitted-Cross-Domain-Policies"</span><span class="p">:</span><span class="w"> </span><span class="s2">"none"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Request-Id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"08bff080-bbb5-4183-b845-81de3d47120a"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Runtime"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.394766"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"X-Xss-Protection"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1; mode=block"</span><span class="w">
|
||
</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">"<!doctype html><html lang=</span><span class="se">\"</span><span class="s2">zh-CN</span><span class="se">\"</span><span class="s2"> class=</span><span class="se">\"</span><span class="s2">notranslate translated-ltr</span><span class="se">\"</span><span class="s2"> translate=</span><span class="se">\"</span><span class="s2">no</span><span class="se">\"</span><span class="s2">><head><meta charset=</span><span class="se">\"</span><span class="s2">utf-8</span><span class="se">\"</span><span class="s2">><meta name=</span><span class="se">\"</span><span class="s2">”Keywords”</span><span class="se">\"</span><span class="s2"> content=</span><span class="se">\"</span><span class="s2">”trustie,trustieforge,forge,确实让创建更美好,协同开发平台″</span><span class="se">\"</span><span class="s2">><meta name=</span><span class="se">\"</span><span class="s2">”Keywords”</span><span class="se">\"</span><span class="s2"> content=</span><span class="se">\"</span><span class="s2">”TrustieOpenSourceProject″</span><span class="se">\"</span><span class="s2">><meta name=</span><span class="se">\"</span><span class="s2">”Keywords”</span><span class="se">\"</span><span class="s2"> content=</span><span class="se">\"</span><span class="s2">”issue,bug,tracker,软件工程,课程实践″</span><span class="se">\"</span><span class="s2">><meta name=</span><span class="se">\"</span><span class="s2">”Description”</span><span class="se">\"</span><span class="s2"> content=</span><span class="se">\"</span><span class="s2">”持续构建协同、共享、可信的软件创建生态开源创作与软件生产相结合，支持大规模群体开展软件协同创新活动”</span><span class="se">\"</span><span class="s2">><meta name=</span><span class="se">\"</span><span class="s2">theme-color</span><span class="se">\"</span><span class="s2"> content=</span><span class="se">\"</span><span class="s2">#000000</span><span class="se">\"</span><span class="s2">><link rel=</span><span class="se">\"</span><span class="s2">manifest</span><span class="se">\"</span><span class="s2"> href=</span><span class="se">\"</span><span class="s2">/react/build//manifest.json</span><span class="se">\"</span><span class="s2">><link rel=</span><span class="se">\"</span><span class="s2">stylesheet</span><span class="se">\"</span><span class="s2"> href=</span><span class="se">\"</span><span class="s2">/react/build/css/iconfont.css</span><span class="se">\"</span><span class="s2">><link rel=</span><span class="se">\"</span><span class="s2">stylesheet</span><span class="se">\"</span><span class="s2"> href=</span><span class="se">\"</span><span class="s2">/react/build/css/edu-purge.css</span><span class="se">\"</span><span class="s2">><link rel=</span><span class="se">\"</span><span class="s2">stylesheet</span><span class="se">\"</span><span class="s2"> href=</span><span class="se">\"</span><span class="s2">/react/build/css/editormd.min.css</span><span class="se">\"</span><span class="s2">><link rel=</span><span class="se">\"</span><span class="s2">stylesheet</span><span class="se">\"</span><span class="s2"> href=</span><span class="se">\"</span><span class="s2">/react/build/css/merge.css</span><span class="se">\"</span><span class="s2">><link href=</span><span class="se">\"</span><span class="s2">/react/build/static/css/main.07f7e90c.chunk.css</span><span class="se">\"</span><span class="s2"> rel=</span><span class="se">\"</span><span class="s2">stylesheet</span><span class="se">\"</span><span class="s2">></head><body><div id=</span><span class="se">\"</span><span class="s2">md_div</span><span class="se">\"</span><span class="s2"> style=</span><span class="se">\"</span><span class="s2">display:none</span><span class="se">\"</span><span class="s2">></div><div id=</span><span class="se">\"</span><span class="s2">root</span><span class="se">\"</span><span class="s2"> class=</span><span class="se">\"</span><span class="s2">page -layout-v -fit widthunit</span><span class="se">\"</span><span class="s2">></div><div id=</span><span class="se">\"</span><span class="s2">picture_display</span><span class="se">\"</span><span class="s2"> style=</span><span class="se">\"</span><span class="s2">display:none</span><span class="se">\"</span><span class="s2">></div><script src=</span><span class="se">\"</span><span class="s2">/react/build/js/jquery-1.8.3.min.js</span><span class="se">\"</span><span class="s2">></script><script src=</span><span class="se">\"</span><span class="s2">/react/build/js/js_min_all.js</span><span class="se">\"</span><span class="s2">></script><script src=</span><span class="se">\"</span><span class="s2">/react/build/js/codemirror/codemirror.js</span><span class="se">\"</span><span class="s2">></script><script src=</span><span class="se">\"</span><span class="s2">/react/build/js/editormd/editormd.min.js</span><span class="se">\"</span><span class="s2">></script><script src=</span><span class="se">\"</span><span class="s2">/react/build/js/codemirror/merge/merge.js</span><span class="se">\"</span><span class="s2">></script><script src=</span><span class="se">\"</span><span class="s2">/react/build/./static/js/runtime~main.3d644966.js</span><span class="se">\"</span><span class="s2">></script><script src=</span><span class="se">\"</span><span class="s2">/react/build/./static/js/main.e46872e3.chunk.js</span><span class="se">\"</span><span class="s2">></script><script async type=</span><span class="se">\"</span><span class="s2">text/javascript</span><span class="se">\"</span><span class="s2"> id=</span><span class="se">\"</span><span class="s2">mini-profiler</span><span class="se">\"</span><span class="s2"> src=</span><span class="se">\"</span><span class="s2">/mini-profiler-resources/includes.js?v=67dd1c2571ced7fc74ae7f1813e47bdf</span><span class="se">\"</span><span class="s2"> data-version=</span><span class="se">\"</span><span class="s2">67dd1c2571ced7fc74ae7f1813e47bdf</span><span class="se">\"</span><span class="s2"> data-path=</span><span class="se">\"</span><span class="s2">/mini-profiler-resources/</span><span class="se">\"</span><span class="s2"> data-current-id=</span><span class="se">\"</span><span class="s2">9ynvpncz5xm0rpgorb5y</span><span class="se">\"</span><span class="s2"> data-ids=</span><span class="se">\"</span><span class="s2">9ynvpncz5xm0rpgorb5y,hgggd9mv6lr4a9drcrlr,j7zqlx2vy5aji2vtgoba,f1ktsmh3jxvq0z2hf612,mih3dvgvlqhi3zy8lf2x,5k1qbkvbnru8mye9cest,tj6ern8w6awqf2zsimbr,9isaehvubivd52wo5p9v,1rzfhtq1nhuwbgy9p76g,z0xzidzyywna0y7a69m0,hzoklky92ycjqt42gi0s,y0ai7y0t28mcn8x0py2x,322il7nadinp51mw2r5m,m6dukftfsh6tjcxzp1gq,667wlqbytfwbrirnmma1,jcehj3dl8lkw8gk510cr</span><span class="se">\"</span><span class="s2"> data-horizontal-position=</span><span class="se">\"</span><span class="s2">left</span><span class="se">\"</span><span class="s2"> data-vertical-position=</span><span class="se">\"</span><span class="s2">top</span><span class="se">\"</span><span class="s2"> data-trivial=</span><span class="se">\"</span><span class="s2">false</span><span class="se">\"</span><span class="s2"> data-children=</span><span class="se">\"</span><span class="s2">false</span><span class="se">\"</span><span class="s2"> data-max-traces=</span><span class="se">\"</span><span class="s2">20</span><span class="se">\"</span><span class="s2"> data-controls=</span><span class="se">\"</span><span class="s2">false</span><span class="se">\"</span><span class="s2"> data-total-sql-count=</span><span class="se">\"</span><span class="s2">false</span><span class="se">\"</span><span class="s2"> data-authorized=</span><span class="se">\"</span><span class="s2">true</span><span class="se">\"</span><span class="s2"> data-toggle-shortcut=</span><span class="se">\"</span><span class="s2">alt+p</span><span class="se">\"</span><span class="s2"> data-start-hidden=</span><span class="se">\"</span><span class="s2">false</span><span class="se">\"</span><span class="s2"> data-collapse-results=</span><span class="se">\"</span><span class="s2">true</span><span class="se">\"</span><span class="s2"> data-html-container=</span><span class="se">\"</span><span class="s2">body</span><span class="se">\"</span><span class="s2">></script></span><span class="se">\n</span><span class="s2"></body></html>"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"delivered_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2021-07-28 11:47:29"</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='webhook-6'>仓库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> 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-23'>HTTP 请求</h3>
|
||
<p><code>POST /api/:owner/:repo/webhooks/:id/test.json</code></p>
|
||
<h3 id='2eb6f47757-23'>请求参数:</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>integer</td>
|
||
<td>webhook ID</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-23'>返回字段说明:</h3>
|
||
<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">"success"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div>
|
||
<aside class="success">
|
||
Success Data.
|
||
</aside>
|
||
<h1 id='pulls'>Pulls</h1><h2 id='get-a-pull-request'>Get a pull request</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/Jasder/gitlink/pulls/88.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/gitlink/pulls/88.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/pulls/:id.json</code></p>
|
||
<h3 id='2eb6f47757'>请求参数:</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>integer</td>
|
||
<td>pull id值</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">"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">"project_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gitlink"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"forgeplus"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_identifier"</span><span class="p">:</span><span class="w"> </span><span class="s2">"forgeplus"</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">"52分钟前"</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">229</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">328</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"comments_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">"comments_total_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">"pull_request"</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">1189</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">"head"</span><span class="p">:</span><span class="w"> </span><span class="s2">"develop"</span><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">"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">"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">"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">"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">"create_user"</span><span class="p">:</span><span class="w"> </span><span class="s2">"jasder"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"mergeable"</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">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"open"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"issue"</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">51888</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"subject"</span><span class="p">:</span><span class="w"> </span><span class="s2">"FIx release v3.2.0"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"description"</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">"is_private"</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">"branch_name"</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">"project_author_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gitlink"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"closed_on"</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">"2021-10-12 15:51"</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">"victor"</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">"moshenglv"</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">"段甲生"</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">"jasder"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"author_picture"</span><span class="p">:</span><span class="w"> </span><span class="s2">"images/avatars/User/36480?t=1615520120"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"issue_status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"新增"</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">"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><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='pull-request'>获取pull request文件列表</h2>
|
||
<p>获取pull request文件列表</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>
|
||
http://localhost:3000/api/Jason/gitlink/pulls/1/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/jasder/gitlink/pulls/1/files.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-2'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/pulls/:id/files.json</code></p>
|
||
<h3 id='2eb6f47757-2'>请求参数:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数名</th>
|
||
<th>必选</th>
|
||
<th>类型</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>owner</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>用户登录名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>project's identifier</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>是</td>
|
||
<td>int</td>
|
||
<td>pull request's id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>-</td>
|
||
<td>-</td>
|
||
<td>-</td>
|
||
</tr>
|
||
<tr>
|
||
<td>files_count</td>
|
||
<td>int</td>
|
||
<td>文件更改的总数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>total_addition</td>
|
||
<td>int</td>
|
||
<td>添加代码总行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>total_deletion</td>
|
||
<td>int</td>
|
||
<td>删除代码总行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>files</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- sha</td>
|
||
<td>string</td>
|
||
<td>commit's sha value</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>当前文件名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- old_name</td>
|
||
<td>string</td>
|
||
<td>修改之前的文件名称,与name相同的话，说明文件名未更改</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- addition</td>
|
||
<td>int</td>
|
||
<td>文件添加的行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- deletion</td>
|
||
<td>int</td>
|
||
<td>文件删除的行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- type</td>
|
||
<td>int</td>
|
||
<td>文件类型， 1: 表示该文件只添加了内容，2: 表示该文件内容有修改， 3: 表示文件被删除或者改文件只删除了内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isCreated</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否为新增文件, true: 是， false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isDeleted</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否被删除， true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isBin</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否为二进制文件，true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isLFSFile</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否为LFS文件，true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isRenamed</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否被重命名，true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- sections</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- fileName</td>
|
||
<td>string</td>
|
||
<td>文件名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- lines</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ leftIdx</td>
|
||
<td>string</td>
|
||
<td>文件变动之前所在行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ rightIdx</td>
|
||
<td>string</td>
|
||
<td>文件更改后所在行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ type</td>
|
||
<td>string</td>
|
||
<td>文件变更类型，1: 新增，2: 修改， 3: 删除， 4: diff统计信息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ content</td>
|
||
<td>string</td>
|
||
<td>文件变更的内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ sectionInfo</td>
|
||
<td>object</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- path</td>
|
||
<td>string</td>
|
||
<td>文件相对仓库的路径</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- lastLeftIdx</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- lastRightIdx</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- leftHunkSize</td>
|
||
<td>int</td>
|
||
<td>文件变更之前的行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- rightHunkSize</td>
|
||
<td>int</td>
|
||
<td>文件变更之后的行数(及当前页面编辑器显示的总行数)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- leftIdx</td>
|
||
<td>int</td>
|
||
<td>文件变更之前所在行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- rightIdx</td>
|
||
<td>int</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">"files_count"</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">"total_addition"</span><span class="p">:</span><span class="w"> </span><span class="mi">447</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"total_deletion"</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">"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><span class="nl">"sha"</span><span class="p">:</span><span class="w"> </span><span class="s2">"xefenisnii"</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">"文件.txt"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"old_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"文件.txt"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"index"</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">"addition"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"deletion"</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">"type"</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">"isCreated"</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">"isDeleted"</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">"isBin"</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">"isLFSFile"</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">"isRenamed"</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">"isSubmodule"</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">"sections"</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">"fileName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"文件.txt"</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">""</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="p">{</span><span class="w">
|
||
</span><span class="nl">"leftIdx"</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">"rightIdx"</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">"type"</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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"@@ -0,0 +1,2 @@"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sectionInfo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"path"</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">"lastLeftIdx"</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">"lastRightIdx"</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">"leftIdx"</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">"rightIdx"</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">"leftHunkSize"</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">"rightHunkSize"</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><span class="p">},</span><span class="w">
|
||
</span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"leftIdx"</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">"rightIdx"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"+用例图一致性更新"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sectionInfo"</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><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"leftIdx"</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">"rightIdx"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"+工程文件直接上传会有文件缺失，现在压缩后上传"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sectionInfo"</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><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="p">]</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='pull-request-commits'>获取pull request的commits列表</h2>
|
||
<p>获取pull request的commits列表</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/jasder/jasder_test/pulls/1/commits.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/pulls/1/commits.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-3'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/pulls/:id/commits.json</code></p>
|
||
<h3 id='2eb6f47757-3'>请求参数:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数名</th>
|
||
<th>必选</th>
|
||
<th>类型</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>owner</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>用户登录名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>project's identifier</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>是</td>
|
||
<td>int</td>
|
||
<td>pull request's id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-2'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>commits_count</td>
|
||
<td>int</td>
|
||
<td>commits总数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>commits</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- author</td>
|
||
<td>object</td>
|
||
<td>项目作者</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- login</td>
|
||
<td>string</td>
|
||
<td>用户login</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- name</td>
|
||
<td>string</td>
|
||
<td>用户姓名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- image_url</td>
|
||
<td>string</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- committer</td>
|
||
<td>object</td>
|
||
<td>commit提交用户</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- login</td>
|
||
<td>string</td>
|
||
<td>用户login</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- name</td>
|
||
<td>string</td>
|
||
<td>用户姓名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- image_url</td>
|
||
<td>string</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- timestamp</td>
|
||
<td>int</td>
|
||
<td>commit的unix时间戳</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- time_from_now</td>
|
||
<td>string</td>
|
||
<td>commit’s 提交时间距当前时间的时间值</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- message</td>
|
||
<td>string</td>
|
||
<td>commit说明信息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- sha</td>
|
||
<td>string</td>
|
||
<td>commit’s sha值</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">"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">"commits"</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">"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">36480</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">"jasder"</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">"段甲生"</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">"avatars/User/b"</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="mi">36480</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">"jasder"</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">"段甲生"</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">"avatars/User/b"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"timestamp"</span><span class="p">:</span><span class="w"> </span><span class="mi">1604382982</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"time_from_now"</span><span class="p">:</span><span class="w"> </span><span class="s2">"3小时前"</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 some file</span><span class="se">\n</span><span class="s2">* Add the tag list page to the release page</span><span class="se">\n</span><span class="s2">* Apply suggestions from code review</span><span class="se">\n</span><span class="s2">* Add the tags list view</span><span class="se">\n</span><span class="s2">* Add the delete tag way on ui</span><span class="se">\n</span><span class="s2">* Not delete tag and clear message when delete a release</span><span class="se">\n</span><span class="s2">"</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">"8f5faee0d3b3be1b8063e84da0c79dd75327b968"</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='compare-two-commits'>Compare two commits</h2>
|
||
<p>Compare two commits</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>
|
||
http://localhost:3000/api/Jason/test-txt/compare/master...develop
|
||
|
||
curl <span class="nt">-X</span> GET <span class="se">\</span>
|
||
http://localhost:3000/api/Jason/test-txt/compare/master...Jason/test-txt:develop
|
||
</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/Jason/test-txt/compare/master...Jason/test-txt:develop</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-4'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/compare/{base}...{head}.json</code></p>
|
||
<h3 id='2eb6f47757-4'>请求参数:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数名</th>
|
||
<th>必选</th>
|
||
<th>类型</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>owner</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>用户登录名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>repo</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>project's identifier</td>
|
||
</tr>
|
||
<tr>
|
||
<td>base</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>pull request's id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>head</td>
|
||
<td>是</td>
|
||
<td>string</td>
|
||
<td>pull request's id</td>
|
||
</tr>
|
||
</tbody></table>
|
||
<h3 id='7447e4874e-3'>返回字段说明:</h3>
|
||
<table><thead>
|
||
<tr>
|
||
<th>参数</th>
|
||
<th>类型</th>
|
||
<th>字段说明</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>-</td>
|
||
<td>-</td>
|
||
<td>-</td>
|
||
</tr>
|
||
<tr>
|
||
<td>commits_count</td>
|
||
<td>int</td>
|
||
<td>commits总数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>commits</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- author</td>
|
||
<td>object</td>
|
||
<td>项目作者</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- login</td>
|
||
<td>string</td>
|
||
<td>用户login</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- name</td>
|
||
<td>string</td>
|
||
<td>用户姓名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- image_url</td>
|
||
<td>string</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- committer</td>
|
||
<td>object</td>
|
||
<td>commit提交用户</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- login</td>
|
||
<td>string</td>
|
||
<td>用户login</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- name</td>
|
||
<td>string</td>
|
||
<td>用户姓名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- image_url</td>
|
||
<td>string</td>
|
||
<td>用户头像</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- timestamp</td>
|
||
<td>int</td>
|
||
<td>commit的unix时间戳</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- time_from_now</td>
|
||
<td>string</td>
|
||
<td>commit’s 提交时间距当前时间的时间值</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- message</td>
|
||
<td>string</td>
|
||
<td>commit说明信息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- sha</td>
|
||
<td>string</td>
|
||
<td>commit’s sha值</td>
|
||
</tr>
|
||
<tr>
|
||
<td>diff</td>
|
||
<td>object</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- files_count</td>
|
||
<td>int</td>
|
||
<td>文件更改的总数量</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- total_addition</td>
|
||
<td>int</td>
|
||
<td>添加代码总行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- total_deletion</td>
|
||
<td>int</td>
|
||
<td>删除代码总行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- files</td>
|
||
<td>Array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- sha</td>
|
||
<td>string</td>
|
||
<td>commit's sha</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- name</td>
|
||
<td>string</td>
|
||
<td>当前文件名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- old_name</td>
|
||
<td>string</td>
|
||
<td>修改之前的文件名称,与name相同的话，说明文件名未更改</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- addition</td>
|
||
<td>int</td>
|
||
<td>文件添加的行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- deletion</td>
|
||
<td>int</td>
|
||
<td>文件删除的行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- type</td>
|
||
<td>int</td>
|
||
<td>文件类型， 1: 表示该文件只添加了内容，2: 表示该文件内容有修改， 3: 表示文件被删除或者改文件只删除了内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isCreated</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否为新增文件, true: 是， false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isDeleted</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否被删除， true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isBin</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否为二进制文件，true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isLFSFile</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否为LFS文件，true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- isRenamed</td>
|
||
<td>boolean</td>
|
||
<td>当前文件是否被重命名，true: 是，false: 否</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-- sections</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- fileName</td>
|
||
<td>string</td>
|
||
<td>文件名称</td>
|
||
</tr>
|
||
<tr>
|
||
<td>---- lines</td>
|
||
<td>array</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ leftIdx</td>
|
||
<td>string</td>
|
||
<td>文件变动之前所在行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ rightIdx</td>
|
||
<td>string</td>
|
||
<td>文件更改后所在行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ type</td>
|
||
<td>string</td>
|
||
<td>文件变更类型，1: 内容未改动，2: 添加， 3: 删除， 4: diff统计信息</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ content</td>
|
||
<td>string</td>
|
||
<td>文件变更的内容</td>
|
||
</tr>
|
||
<tr>
|
||
<td>------ sectionInfo</td>
|
||
<td>object</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- path</td>
|
||
<td>string</td>
|
||
<td>文件相对仓库的路径</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- lastLeftIdx</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- lastRightIdx</td>
|
||
<td>int</td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- leftHunkSize</td>
|
||
<td>int</td>
|
||
<td>文件变更之前的行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- rightHunkSize</td>
|
||
<td>int</td>
|
||
<td>文件变更之后的行数(及当前页面编辑器显示的总行数)</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- leftIdx</td>
|
||
<td>int</td>
|
||
<td>文件变更之前所在行数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>-------- rightIdx</td>
|
||
<td>int</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">"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">"commits"</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">"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">36480</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">"jasder"</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">"段甲生"</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">"avatars/User/b"</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="mi">36480</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">"jasder"</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">"段甲生"</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">"avatars/User/b"</span><span class="w">
|
||
</span><span class="p">},</span><span class="w">
|
||
</span><span class="nl">"timestamp"</span><span class="p">:</span><span class="w"> </span><span class="mi">1604382982</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"time_from_now"</span><span class="p">:</span><span class="w"> </span><span class="s2">"4小时前"</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 some file</span><span class="se">\n</span><span class="s2">* Add the tag list page to the release page</span><span class="se">\n</span><span class="s2">* Apply suggestions from code review</span><span class="se">\n</span><span class="s2">* Add the tags list view</span><span class="se">\n</span><span class="s2">* Add the delete tag way on ui</span><span class="se">\n</span><span class="s2">* Not delete tag and clear message when delete a release</span><span class="se">\n</span><span class="s2">"</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">"8f5faee0d3b3be1b8063e84da0c79dd75327b968"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">],</span><span class="w">
|
||
</span><span class="nl">"diff"</span><span class="p">:</span><span class="w"> </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">6</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"total_addition"</span><span class="p">:</span><span class="w"> </span><span class="mi">447</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"total_deletion"</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">"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><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"build.go"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"old_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"build.go"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"index"</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">"addition"</span><span class="p">:</span><span class="w"> </span><span class="mi">33</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"deletion"</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">"type"</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">"isCreated"</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">"isDeleted"</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">"isBin"</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">"isLFSFile"</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">"isRenamed"</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">"isSubmodule"</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">"sections"</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">"fileName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"build.go"</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">""</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="p">{</span><span class="w">
|
||
</span><span class="nl">"leftIdx"</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">"rightIdx"</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">"type"</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">"content"</span><span class="p">:</span><span class="w"> </span><span class="s2">"@@ -0,0 +1,33 @@"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sectionInfo"</span><span class="p">:</span><span class="w"> </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">"build.go"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"lastLeftIdx"</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">"lastRightIdx"</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">"leftIdx"</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">"rightIdx"</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">"leftHunkSize"</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">"rightHunkSize"</span><span class="p">:</span><span class="w"> </span><span class="mi">33</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">"leftIdx"</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">"rightIdx"</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">"type"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">"+// Copyright 2020 The Gitea Authors. All rights reserved."</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"sectionInfo"</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><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="p">]</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h2 id='list-pull-requests'>List pull requests</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/Jasder/gitlink/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">GET /api/Jasder/gitlink/pulls.json</span><span class="dl">'</span><span class="p">)</span>
|
||
</code></pre></div><h3 id='http-5'>HTTP 请求</h3>
|
||
<p><code>GET /api/:owner/:repo/pulls.json</code></p>
|
||
<h3 id='2eb6f47757-5'>请求参数:</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>
|
||
</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">"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">"open_count"</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">"close_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">51</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"merged_issues_size"</span><span class="p">:</span><span class="w"> </span><span class="mi">123</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"search_count"</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">"limit"</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">"user_admin_or_member"</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">"user_admin_or_developer"</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">"project_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gitlink"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"project_author_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Gitlink"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"issues"</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">"pull_request_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1189</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">"develop"</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">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">51888</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">"FIx release v3.2.0"</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">"59分钟前"</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">"victor"</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">"moshenglv"</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">"段甲生"</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">"jasder"</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">"images/avatars/User/36480?t=1615520120"</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><span class="p">]</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre></div><h1 id='issues'>Issues</h1><h1 id='organizations'>Organizations</h1><h1 id='teams'>Teams</h1><h1 id='errors'>Errors</h1>
|
||
<aside class="notice">
|
||
This error section is stored in a separate file in <code>includes/_errors.md</code>. Slate allows you to optionally separate out your docs into many files...just save them to the <code>includes</code> folder and add them to the top of your <code>index.md</code>'s frontmatter. Files are included in the order listed.
|
||
</aside>
|
||
|
||
<p>The Kittn API uses the following error codes:</p>
|
||
|
||
<table><thead>
|
||
<tr>
|
||
<th>Error Code</th>
|
||
<th>Meaning</th>
|
||
</tr>
|
||
</thead><tbody>
|
||
<tr>
|
||
<td>400</td>
|
||
<td>Bad Request -- Your request is invalid.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>401</td>
|
||
<td>Unauthorized -- Your API key is wrong.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>403</td>
|
||
<td>Forbidden -- The kitten requested is hidden for administrators only.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>404</td>
|
||
<td>Not Found -- The specified kitten could not be found.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>405</td>
|
||
<td>Method Not Allowed -- You tried to access a kitten with an invalid method.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>406</td>
|
||
<td>Not Acceptable -- You requested a format that isn't json.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>410</td>
|
||
<td>Gone -- The kitten requested has been removed from our servers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>418</td>
|
||
<td>I'm a teapot.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>429</td>
|
||
<td>Too Many Requests -- You're requesting too many kittens! Slow down!</td>
|
||
</tr>
|
||
<tr>
|
||
<td>500</td>
|
||
<td>Internal Server Error -- We had a problem with our server. Try again later.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>503</td>
|
||
<td>Service Unavailable -- We're temporarily offline for maintenance. Please try again later.</td>
|
||
</tr>
|
||
</tbody></table>
|
||
|
||
</div>
|
||
<div class="dark-box">
|
||
<div class="lang-selector">
|
||
<a href="#" data-language-name="shell">Shell</a>
|
||
<a href="#" data-language-name="javascript">JavaScript</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html>
|