forked from Gitlink/forgeplus
merge from develop
This commit is contained in:
commit
7e5d5e31e5
266
Gemfile
266
Gemfile
|
|
@ -1,130 +1,136 @@
|
|||
source 'https://gems.ruby-china.com'
|
||||
git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
||||
|
||||
gem 'rails', '~> 5.2.0'
|
||||
gem 'mysql2', '>= 0.4.4', '< 0.6.0'
|
||||
gem 'puma', '~> 3.11'
|
||||
gem 'sass-rails', '~> 5.0'
|
||||
gem 'uglifier', '>= 1.3.0'
|
||||
|
||||
# gem 'coffee-rails', '~> 4.2'
|
||||
gem 'turbolinks', '~> 5'
|
||||
gem 'jbuilder', '~> 2.5'
|
||||
gem 'groupdate', '~> 4.1.0'
|
||||
gem 'chartkick'
|
||||
gem 'grape-entity', '~> 0.7.1'
|
||||
gem 'kaminari', '~> 1.1', '>= 1.1.1'
|
||||
|
||||
gem 'bootsnap', '>= 1.1.0', require: false
|
||||
|
||||
gem 'chinese_pinyin'
|
||||
|
||||
gem 'rack-cors'
|
||||
gem 'redis-rails'
|
||||
gem 'roo-xls'
|
||||
gem 'simple_xlsx_reader'
|
||||
|
||||
gem 'rubyzip'
|
||||
|
||||
gem 'spreadsheet'
|
||||
gem 'ruby-ole'
|
||||
# 导出为xlsx
|
||||
gem 'axlsx', '~> 3.0.0.pre'
|
||||
gem 'axlsx_rails', '~> 0.5.2'
|
||||
|
||||
gem 'oauth2'
|
||||
#导出为pdf
|
||||
gem 'pdfkit'
|
||||
gem 'wkhtmltopdf-binary'
|
||||
# gem 'request_store'
|
||||
#gem 'iconv'
|
||||
# markdown 转html
|
||||
gem 'redcarpet', '~> 3.4'
|
||||
|
||||
gem 'rqrcode', '~> 0.10.1'
|
||||
gem 'rqrcode_png'
|
||||
|
||||
gem 'acts-as-taggable-on', '~> 6.0'
|
||||
|
||||
# a tree structure
|
||||
gem 'ancestry'
|
||||
gem 'acts_as_list'
|
||||
gem 'omniauth-cas'
|
||||
|
||||
# profiler Middleware
|
||||
gem 'rack-mini-profiler'
|
||||
|
||||
# object-based searching
|
||||
gem 'ransack'
|
||||
|
||||
group :development, :test do
|
||||
gem 'rspec-rails', '~> 3.8'
|
||||
end
|
||||
|
||||
group :development do
|
||||
gem 'prettier'
|
||||
gem 'rubocop', '~> 0.52.0'
|
||||
gem 'solargraph', '~> 0.38.0'
|
||||
gem 'awesome_print'
|
||||
gem 'web-console', '>= 3.3.0'
|
||||
gem 'listen', '>= 3.0.5', '< 3.2'
|
||||
gem 'spring'
|
||||
gem 'spring-watcher-listen', '~> 2.0.0'
|
||||
gem "annotate", "~> 2.6.0"
|
||||
end
|
||||
|
||||
group :test do
|
||||
gem 'capybara', '>= 2.15', '< 4.0'
|
||||
gem 'selenium-webdriver'
|
||||
gem 'chromedriver-helper'
|
||||
end
|
||||
|
||||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
|
||||
#编码检测
|
||||
gem 'rchardet', '~> 1.8'
|
||||
|
||||
# http client
|
||||
gem 'faraday', '~> 0.15.4'
|
||||
|
||||
# view
|
||||
gem 'active_decorator'
|
||||
gem 'bootstrap', '~> 4.3.1'
|
||||
gem 'jquery-rails'
|
||||
gem 'simple_form'
|
||||
gem 'font-awesome-sass', '4.7.0'
|
||||
|
||||
# i18n
|
||||
gem 'rails-i18n', '~> 5.1'
|
||||
|
||||
# job
|
||||
gem 'sidekiq'
|
||||
gem 'sinatra'
|
||||
gem "sidekiq-cron", "~> 1.1"
|
||||
|
||||
# batch insert
|
||||
gem 'bulk_insert'
|
||||
|
||||
# elasticsearch
|
||||
gem 'searchkick'
|
||||
|
||||
gem 'aasm'
|
||||
gem 'enumerize'
|
||||
|
||||
gem 'diffy'
|
||||
|
||||
gem 'deep_cloneable', '~> 3.0.0'
|
||||
|
||||
# oauth2
|
||||
gem 'omniauth', '~> 1.9.0'
|
||||
gem 'omniauth-oauth2', '~> 1.6.0'
|
||||
|
||||
# global var
|
||||
gem 'request_store'
|
||||
|
||||
# 敏感词汇
|
||||
gem 'harmonious_dictionary', '~> 0.0.1'
|
||||
|
||||
gem 'parallel', '~> 1.19', '>= 1.19.1'
|
||||
|
||||
gem 'letter_avatar'
|
||||
source 'https://gems.ruby-china.com'
|
||||
git_source(:github) { |repo| "https://github.com/#{repo}.git" }
|
||||
|
||||
gem 'rails', '~> 5.2.0'
|
||||
gem 'mysql2', '>= 0.4.4', '< 0.6.0'
|
||||
gem 'puma', '~> 3.11'
|
||||
gem 'sass-rails', '~> 5.0'
|
||||
gem 'uglifier', '>= 1.3.0'
|
||||
|
||||
# gem 'coffee-rails', '~> 4.2'
|
||||
gem 'turbolinks', '~> 5'
|
||||
gem 'jbuilder', '~> 2.5'
|
||||
gem 'groupdate', '~> 4.1.0'
|
||||
gem 'chartkick'
|
||||
gem 'grape-entity', '~> 0.7.1'
|
||||
gem 'kaminari', '~> 1.1', '>= 1.1.1'
|
||||
|
||||
gem 'bootsnap', '>= 1.1.0', require: false
|
||||
|
||||
gem 'chinese_pinyin'
|
||||
|
||||
gem 'rack-cors'
|
||||
gem 'redis-rails'
|
||||
gem 'roo-xls'
|
||||
gem 'simple_xlsx_reader'
|
||||
|
||||
gem 'rubyzip'
|
||||
|
||||
gem 'spreadsheet'
|
||||
gem 'ruby-ole'
|
||||
# 导出为xlsx
|
||||
gem 'axlsx', '~> 3.0.0.pre'
|
||||
gem 'axlsx_rails', '~> 0.5.2'
|
||||
|
||||
gem 'oauth2'
|
||||
#导出为pdf
|
||||
gem 'pdfkit'
|
||||
gem 'wkhtmltopdf-binary'
|
||||
# gem 'request_store'
|
||||
#gem 'iconv'
|
||||
# markdown 转html
|
||||
gem 'redcarpet', '~> 3.4'
|
||||
|
||||
gem 'rqrcode', '~> 0.10.1'
|
||||
gem 'rqrcode_png'
|
||||
|
||||
gem 'acts-as-taggable-on', '~> 6.0'
|
||||
|
||||
# a tree structure
|
||||
gem 'ancestry'
|
||||
gem 'acts_as_list'
|
||||
gem 'omniauth-cas'
|
||||
|
||||
# profiler Middleware
|
||||
gem 'rack-mini-profiler'
|
||||
|
||||
# object-based searching
|
||||
gem 'ransack'
|
||||
|
||||
group :development, :test do
|
||||
gem 'rspec-rails', '~> 3.8'
|
||||
end
|
||||
|
||||
group :development do
|
||||
gem 'prettier'
|
||||
gem 'rubocop', '~> 0.52.0'
|
||||
gem 'solargraph', '~> 0.38.0'
|
||||
gem 'awesome_print'
|
||||
gem 'web-console', '>= 3.3.0'
|
||||
gem 'listen', '>= 3.0.5', '< 3.2'
|
||||
gem 'spring'
|
||||
gem 'spring-watcher-listen', '~> 2.0.0'
|
||||
gem "annotate", "~> 2.6.0"
|
||||
end
|
||||
|
||||
group :test do
|
||||
gem 'capybara', '>= 2.15', '< 4.0'
|
||||
gem 'selenium-webdriver'
|
||||
gem 'chromedriver-helper'
|
||||
end
|
||||
|
||||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
|
||||
#编码检测
|
||||
gem 'rchardet', '~> 1.8'
|
||||
|
||||
# http client
|
||||
gem 'faraday', '~> 0.15.4'
|
||||
|
||||
# view
|
||||
gem 'active_decorator'
|
||||
gem 'bootstrap', '~> 4.3.1'
|
||||
gem 'jquery-rails'
|
||||
gem 'simple_form'
|
||||
gem 'font-awesome-sass', '4.7.0'
|
||||
|
||||
# i18n
|
||||
gem 'rails-i18n', '~> 5.1'
|
||||
|
||||
# job
|
||||
gem 'sidekiq'
|
||||
gem 'sinatra'
|
||||
gem "sidekiq-cron", "~> 1.1"
|
||||
|
||||
# batch insert
|
||||
gem 'bulk_insert'
|
||||
|
||||
# elasticsearch
|
||||
gem 'searchkick'
|
||||
|
||||
gem 'aasm'
|
||||
gem 'enumerize'
|
||||
|
||||
gem 'diffy'
|
||||
|
||||
gem 'deep_cloneable', '~> 3.0.0'
|
||||
|
||||
# oauth2
|
||||
gem 'omniauth', '~> 1.9.0'
|
||||
gem 'omniauth-oauth2', '~> 1.6.0'
|
||||
|
||||
# global var
|
||||
gem 'request_store'
|
||||
|
||||
# 敏感词汇
|
||||
gem 'harmonious_dictionary', '~> 0.0.1'
|
||||
|
||||
gem 'parallel', '~> 1.19', '>= 1.19.1'
|
||||
|
||||
gem 'letter_avatar'
|
||||
|
||||
gem 'jwt'
|
||||
|
||||
gem 'doorkeeper'
|
||||
|
||||
gem 'doorkeeper-jwt'
|
||||
|
|
|
|||
|
|
@ -106,6 +106,10 @@ GEM
|
|||
activerecord (>= 3.1.0, < 7)
|
||||
diff-lcs (1.3)
|
||||
diffy (3.3.0)
|
||||
doorkeeper (5.5.4)
|
||||
railties (>= 5)
|
||||
doorkeeper-jwt (0.4.1)
|
||||
jwt (>= 2.1)
|
||||
e2mmap (0.1.0)
|
||||
elasticsearch (7.5.0)
|
||||
elasticsearch-api (= 7.5.0)
|
||||
|
|
@ -450,6 +454,8 @@ DEPENDENCIES
|
|||
chromedriver-helper
|
||||
deep_cloneable (~> 3.0.0)
|
||||
diffy
|
||||
doorkeeper
|
||||
doorkeeper-jwt
|
||||
enumerize
|
||||
faraday (~> 0.15.4)
|
||||
font-awesome-sass (= 4.7.0)
|
||||
|
|
@ -458,6 +464,7 @@ DEPENDENCIES
|
|||
harmonious_dictionary (~> 0.0.1)
|
||||
jbuilder (~> 2.5)
|
||||
jquery-rails
|
||||
jwt
|
||||
kaminari (~> 1.1, >= 1.1.1)
|
||||
letter_avatar
|
||||
listen (>= 3.0.5, < 3.2)
|
||||
|
|
|
|||
|
|
@ -265,9 +265,12 @@ class ApplicationController < ActionController::Base
|
|||
User.current = user
|
||||
end
|
||||
end
|
||||
# if !User.current.logged? && Rails.env.development?
|
||||
# User.current = User.find 1
|
||||
# end
|
||||
|
||||
if !User.current.logged? && Rails.env.development?
|
||||
user = User.find 1
|
||||
User.current = user
|
||||
start_user_session(user)
|
||||
end
|
||||
|
||||
|
||||
# 测试版前端需求
|
||||
|
|
|
|||
|
|
@ -0,0 +1,42 @@
|
|||
class Projects::ProjectInviteLinksController < Projects::BaseController
|
||||
before_action :require_manager!, except: [:show_link, :redirect_link]
|
||||
before_action :require_login
|
||||
|
||||
def current_link
|
||||
role = params[:role]
|
||||
is_apply = params[:is_apply]
|
||||
return render_error('请输入正确的参数！') unless role.present? && is_apply.present?
|
||||
@project_invite_link = ProjectInviteLink.find_by(user_id: current_user.id, project_id: @project.id, role: role, is_apply: is_apply)
|
||||
@project_invite_link = ProjectInviteLink.build!(@project, current_user, role, is_apply) unless @project_invite_link.present?
|
||||
end
|
||||
|
||||
def generate_link
|
||||
ActiveRecord::Base.transaction do
|
||||
params_data = link_params.merge({user_id: current_user.id, project_id: @project.id})
|
||||
Projects::ProjectInviteLinks::CreateForm.new(params_data).validate!
|
||||
@project_invite_link = ProjectInviteLink.build!(project, user, params_data[:role], params_data[:is_apply])
|
||||
end
|
||||
rescue Exception => e
|
||||
uid_logger_error(e.message)
|
||||
tip_exception(e.message)
|
||||
end
|
||||
|
||||
def show_link
|
||||
@project_invite_link = ProjectInviteLink.find_by(sign: params[:invite_sign])
|
||||
return render_not_found unless @project_invite_link.present?
|
||||
end
|
||||
|
||||
def redirect_link
|
||||
Projects::LinkJoinService.call(current_user, @project, params[:invite_sign])
|
||||
render_ok
|
||||
rescue Exception => e
|
||||
uid_logger_error(e.message)
|
||||
tip_exception(e.message)
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
def link_params
|
||||
params.require(:project_invite_link).permit(:role, :is_apply)
|
||||
end
|
||||
end
|
||||
|
|
@ -1,4 +1,278 @@
|
|||
# Projects
|
||||
## 获取项目邀请链接（项目管理员）
|
||||
当前登录（管理员）用户获取项目邀请链接的接口（第一次请求会默认生成role类型为developer和is_apply为true的链接）
|
||||
|
||||
> 示例:
|
||||
|
||||
```shell
|
||||
curl -X GET http://localhost:3000/api/yystopf/kellect/project_invite_links/current_link.json
|
||||
```
|
||||
|
||||
```javascript
|
||||
await octokit.request('GET /api/yystopf/kellect/project_invite_links/current_link.json')
|
||||
```
|
||||
|
||||
### HTTP 请求
|
||||
`GET /api/:owner/:repo/project_invite_links/current_link.json`
|
||||
|
||||
### 请求参数
|
||||
参数 | 必选 | 默认 | 类型 | 字段说明
|
||||
--------- | ------- | ------- | -------- | ----------
|
||||
|role |是| |string |项目权限，reporter: 报告者, developer: 开发者，manager：管理员 |
|
||||
|is_apply |是| |boolean |是否需要审核 |
|
||||
|
||||
### 返回字段说明
|
||||
参数 | 类型 | 字段说明
|
||||
--------- | ----------- | -----------
|
||||
|id |int |链接id |
|
||||
|role |string |邀请角色|
|
||||
|is_apply |boolean |是否需要审核 |
|
||||
|sign |string |邀请标识(放在链接后面即可)|
|
||||
|expired_at |string |链接过期时间|
|
||||
|user.id |int |链接创建者的id |
|
||||
|user.type |string |链接创建者的类型 |
|
||||
|user.name |string |链接创建者的名称 |
|
||||
|user.login |string |链接创建者的标识 |
|
||||
|user.image_url |string |链接创建者头像 |
|
||||
|project.id |int |链接关联项目的id |
|
||||
|project.identifier |string |链接关联项目的标识 |
|
||||
|project.name |string |链接关联项目的名称 |
|
||||
|project.description |string |链接关联项目的描述 |
|
||||
|project.is_public |bool |链接关联项目是否公开 |
|
||||
|project.owner.id |bool |链接关联项目拥有者id |
|
||||
|project.owner.type |string |链接关联项目拥有者类型 |
|
||||
|project.owner.name |string |链接关联项目拥有者昵称 |
|
||||
|project.owner.login |string |链接关联项目拥有者标识 |
|
||||
|project.owner.image_url|string |链接关联项目拥有者头像 |
|
||||
|
||||
> 返回的JSON示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 7,
|
||||
"role": "developer",
|
||||
"is_apply": false,
|
||||
"sign": "6b6b454843c291d4e52e60853cb8ad9f",
|
||||
"expired_at": "2022-06-23 10:08",
|
||||
"user": {
|
||||
"id": 2,
|
||||
"type": "User",
|
||||
"name": "heh",
|
||||
"login": "yystopf",
|
||||
"image_url": "system/lets/letter_avatars/2/H/188_239_142/120.png"
|
||||
},
|
||||
"project": {
|
||||
"id": 474,
|
||||
"identifier": "kellect",
|
||||
"name": "kellect",
|
||||
"description": null,
|
||||
"is_public": true,
|
||||
"owner": {
|
||||
"id": 2,
|
||||
"type": "User",
|
||||
"name": "heh",
|
||||
"login": "yystopf",
|
||||
"image_url": "system/lets/letter_avatars/2/H/188_239_142/120.png"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
## 生成项目邀请链接（项目管理员）
|
||||
当前登录（管理员）用户生成的项目邀请链接，可选role和is_apply参数
|
||||
|
||||
> 示例:
|
||||
|
||||
```shell
|
||||
curl -X POST http://localhost:3000/api/yystopf/kellect/project_invite_links/generate_link.json
|
||||
```
|
||||
|
||||
```javascript
|
||||
await octokit.request('POST /api/yystopf/kellect/project_invite_links/generate_link.json')
|
||||
```
|
||||
|
||||
### HTTP 请求
|
||||
`POST /api/:owner/:repo/project_invite_links/generate_link.json`
|
||||
|
||||
### 请求参数
|
||||
参数 | 必选 | 默认 | 类型 | 字段说明
|
||||
--------- | ------- | ------- | -------- | ----------
|
||||
|role |是| |string |项目权限，reporter: 报告者, developer: 开发者，manager：管理员 |
|
||||
|is_apply |是| |boolean |是否需要审核 |
|
||||
|
||||
|
||||
> 请求的JSON示例
|
||||
|
||||
```json
|
||||
{
|
||||
"role": "developer",
|
||||
"is_apply": false
|
||||
}
|
||||
```
|
||||
|
||||
### 返回字段说明
|
||||
参数 | 类型 | 字段说明
|
||||
--------- | ----------- | -----------
|
||||
|id |int |链接id |
|
||||
|role |string |邀请角色|
|
||||
|is_apply |boolean |是否需要审核 |
|
||||
|sign |string |邀请标识(放在链接后面即可)|
|
||||
|expired_at |string |链接过期时间|
|
||||
|user.id |int |链接创建者的id |
|
||||
|user.type |string |链接创建者的类型 |
|
||||
|user.name |string |链接创建者的名称 |
|
||||
|user.login |string |链接创建者的标识 |
|
||||
|user.image_url |string |链接创建者头像 |
|
||||
|project.id |int |链接关联项目的id |
|
||||
|project.identifier |string |链接关联项目的标识 |
|
||||
|project.name |string |链接关联项目的名称 |
|
||||
|project.description |string |链接关联项目的描述 |
|
||||
|project.is_public |bool |链接关联项目是否公开 |
|
||||
|project.owner.id |bool |链接关联项目拥有者id |
|
||||
|project.owner.type |string |链接关联项目拥有者类型 |
|
||||
|project.owner.name |string |链接关联项目拥有者昵称 |
|
||||
|project.owner.login |string |链接关联项目拥有者标识 |
|
||||
|project.owner.image_url|string |链接关联项目拥有者头像 |
|
||||
|
||||
> 返回的JSON示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 7,
|
||||
"role": "developer",
|
||||
"is_apply": false,
|
||||
"sign": "6b6b454843c291d4e52e60853cb8ad9f",
|
||||
"expired_at": "2022-06-23 10:08",
|
||||
"user": {
|
||||
"id": 2,
|
||||
"type": "User",
|
||||
"name": "heh",
|
||||
"login": "yystopf",
|
||||
"image_url": "system/lets/letter_avatars/2/H/188_239_142/120.png"
|
||||
},
|
||||
"project": {
|
||||
"id": 474,
|
||||
"identifier": "kellect",
|
||||
"name": "kellect",
|
||||
"description": null,
|
||||
"is_public": true,
|
||||
"owner": {
|
||||
"id": 2,
|
||||
"type": "User",
|
||||
"name": "heh",
|
||||
"login": "yystopf",
|
||||
"image_url": "system/lets/letter_avatars/2/H/188_239_142/120.png"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 获取邀请链接信息（被邀请用户）
|
||||
用户请求邀请链接时，通过该接口来获取链接的信息
|
||||
|
||||
> 示例:
|
||||
|
||||
```shell
|
||||
curl -X GET http://localhost:3000/api/yystopf/kellect/project_invite_links/show_link.json?invite_sign=d612df03aad63760445c187bcf83f2e6
|
||||
```
|
||||
|
||||
```javascript
|
||||
await octokit.request('POST /api/yystopf/kellect/project_invite_links/show_link.json?invite_sign=d612df03aad63760445c187bcf83f2e6')
|
||||
```
|
||||
|
||||
### HTTP 请求
|
||||
`POST /api/:owner/:repo/project_invite_links/show_link.json?invite_sign=xxx`
|
||||
|
||||
### 请求参数
|
||||
参数 | 必选 | 默认 | 类型 | 字段说明
|
||||
--------- | ------- | ------- | -------- | ----------
|
||||
|invite_sign |是| |string |项目邀请链接的标识 |
|
||||
|
||||
### 返回字段说明
|
||||
参数 | 类型 | 字段说明
|
||||
--------- | ----------- | -----------
|
||||
|id |int |链接id |
|
||||
|role |string |邀请角色|
|
||||
|is_apply |boolean |是否需要审核 |
|
||||
|sign |string |邀请标识(放在链接后面即可)|
|
||||
|expired_at |string |链接过期时间|
|
||||
|user.id |int |链接创建者的id |
|
||||
|user.type |string |链接创建者的类型 |
|
||||
|user.name |string |链接创建者的名称 |
|
||||
|user.login |string |链接创建者的标识 |
|
||||
|user.image_url |string |链接创建者头像 |
|
||||
|project.id |int |链接关联项目的id |
|
||||
|project.identifier |string |链接关联项目的标识 |
|
||||
|project.name |string |链接关联项目的名称 |
|
||||
|project.description |string |链接关联项目的描述 |
|
||||
|project.is_public |bool |链接关联项目是否公开 |
|
||||
|project.owner.id |bool |链接关联项目拥有者id |
|
||||
|project.owner.type |string |链接关联项目拥有者类型 |
|
||||
|project.owner.name |string |链接关联项目拥有者昵称 |
|
||||
|project.owner.login |string |链接关联项目拥有者标识 |
|
||||
|project.owner.image_url|string |链接关联项目拥有者头像 |
|
||||
|
||||
> 返回的JSON示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 7,
|
||||
"role": "developer",
|
||||
"is_apply": false,
|
||||
"sign": "6b6b454843c291d4e52e60853cb8ad9f",
|
||||
"expired_at": "2022-06-23 10:08",
|
||||
"user": {
|
||||
"id": 2,
|
||||
"type": "User",
|
||||
"name": "heh",
|
||||
"login": "yystopf",
|
||||
"image_url": "system/lets/letter_avatars/2/H/188_239_142/120.png"
|
||||
},
|
||||
"project": {
|
||||
"id": 474,
|
||||
"identifier": "kellect",
|
||||
"name": "kellect",
|
||||
"description": null,
|
||||
"is_public": true,
|
||||
"owner": {
|
||||
"id": 2,
|
||||
"type": "User",
|
||||
"name": "heh",
|
||||
"login": "yystopf",
|
||||
"image_url": "system/lets/letter_avatars/2/H/188_239_142/120.png"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 接受项目邀请链接（被邀请用户）
|
||||
当前登录（非项目）用户加入项目的接口，如果项目链接不需要审核，请求成功后即加入项目，如果需要审核，那么会提交一个申请，需要项目管理员审核
|
||||
|
||||
> 示例:
|
||||
|
||||
```shell
|
||||
curl -X POST http://localhost:3000/api/yystopf/kellect/project_invite_links/redirect_link.json?invite_sign=d612df03aad63760445c187bcf83f2e6
|
||||
```
|
||||
|
||||
```javascript
|
||||
await octokit.request('POST /api/yystopf/kellect/project_invite_links/redirect_link.json?invite_sign=d612df03aad63760445c187bcf83f2e6')
|
||||
```
|
||||
|
||||
### HTTP 请求
|
||||
`POST /api/:owner/:repo/project_invite_links/redirect_link.json?invite_sign=xxx`
|
||||
|
||||
### 请求参数
|
||||
参数 | 必选 | 默认 | 类型 | 字段说明
|
||||
--------- | ------- | ------- | -------- | ----------
|
||||
|invite_sign |是| |string |项目邀请链接的标识 |
|
||||
|
||||
> 返回的JSON示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": 0,
|
||||
"message": "success"
|
||||
}
|
||||
```
|
||||
|
||||
## 申请加入项目
|
||||
申请加入项目
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
class Projects::ProjectInviteLinks::CreateForm < BaseForm
|
||||
attr_accessor :user_id, :project_id, :role, :is_apply
|
||||
|
||||
validates :user_id, :project_id, :role, presence: true
|
||||
validates :role, inclusion: { in: %w(manager developer reporter), message: "请输入正确的权限." }
|
||||
validates :is_apply, inclusion: {in: [true, false], message: "请输入是否需要管理员审核."}
|
||||
end
|
||||
|
||||
|
|
@ -2,24 +2,27 @@
|
|||
#
|
||||
# Table name: forge_applied_projects
|
||||
#
|
||||
# id :integer not null, primary key
|
||||
# project_id :integer
|
||||
# user_id :integer
|
||||
# role :integer default("0")
|
||||
# status :integer default("0")
|
||||
# created_at :datetime not null
|
||||
# updated_at :datetime not null
|
||||
# id :integer not null, primary key
|
||||
# project_id :integer
|
||||
# user_id :integer
|
||||
# role :integer default("0")
|
||||
# status :integer default("0")
|
||||
# created_at :datetime not null
|
||||
# updated_at :datetime not null
|
||||
# project_invite_link_id :integer
|
||||
#
|
||||
# Indexes
|
||||
#
|
||||
# index_forge_applied_projects_on_project_id (project_id)
|
||||
# index_forge_applied_projects_on_user_id (user_id)
|
||||
# index_forge_applied_projects_on_project_id (project_id)
|
||||
# index_forge_applied_projects_on_project_invite_link_id (project_invite_link_id)
|
||||
# index_forge_applied_projects_on_user_id (user_id)
|
||||
#
|
||||
|
||||
class AppliedProject < ApplicationRecord
|
||||
self.table_name = "forge_applied_projects"
|
||||
belongs_to :user
|
||||
belongs_to :project
|
||||
belongs_to :project_invite_link, optional: true
|
||||
|
||||
has_many :applied_messages, as: :applied, dependent: :destroy
|
||||
# has_many :forge_activities, as: :forge_act, dependent: :destroy
|
||||
|
|
|
|||
|
|
@ -125,6 +125,7 @@ class Project < ApplicationRecord
|
|||
has_many :has_pinned_users, through: :pinned_projects, source: :user
|
||||
has_many :webhooks, class_name: "Gitea::Webhook", primary_key: :gpid, foreign_key: :repo_id
|
||||
has_many :user_trace_tasks, dependent: :destroy
|
||||
has_many :project_invite_links, dependent: :destroy
|
||||
after_create :incre_user_statistic, :incre_platform_statistic
|
||||
after_save :check_project_members
|
||||
before_save :set_invite_code, :reset_unmember_followed, :set_recommend_and_is_pinned, :reset_cache_data
|
||||
|
|
|
|||
|
|
@ -0,0 +1,59 @@
|
|||
# == Schema Information
|
||||
#
|
||||
# Table name: project_invite_links
|
||||
#
|
||||
# id :integer not null, primary key
|
||||
# project_id :integer
|
||||
# user_id :integer
|
||||
# role :integer default("4")
|
||||
# is_apply :boolean default("1")
|
||||
# sign :string(255)
|
||||
# expired_at :datetime
|
||||
# created_at :datetime not null
|
||||
# updated_at :datetime not null
|
||||
#
|
||||
# Indexes
|
||||
#
|
||||
# index_project_invite_links_on_project_id (project_id)
|
||||
# index_project_invite_links_on_sign (sign)
|
||||
# index_project_invite_links_on_user_id (user_id)
|
||||
#
|
||||
|
||||
class ProjectInviteLink < ApplicationRecord
|
||||
|
||||
default_scope { where("expired_at > ?", Time.now).or(where(expired_at: nil)) }
|
||||
|
||||
belongs_to :project
|
||||
belongs_to :user
|
||||
has_many :applied_projects
|
||||
|
||||
scope :with_project_id, -> (project_id) {where(project_id: project_id)}
|
||||
scope :with_user_id, -> (user_id) {where(user_id: user_id)}
|
||||
|
||||
enum role: {manager: 3, developer: 4, reporter: 5}
|
||||
|
||||
before_create :set_old_data_expired_at
|
||||
|
||||
def self.random_hex_sign
|
||||
hex = (SecureRandom.hex(32))
|
||||
return hex unless ProjectInviteLink.where(sign: hex).exists?
|
||||
end
|
||||
|
||||
def self.build!(project, user, role="developer", is_apply=true)
|
||||
self.create!(
|
||||
project_id: project&.id,
|
||||
user_id: user&.id,
|
||||
role: role,
|
||||
is_apply: is_apply,
|
||||
sign: random_hex_sign,
|
||||
expired_at: Time.now + 3.days
|
||||
)
|
||||
end
|
||||
|
||||
private
|
||||
def set_old_data_expired_at
|
||||
ProjectInviteLink.where(user_id: self.user_id, project_id: self.project, role: self.role, is_apply: self.is_apply).update_all(expired_at: Time.now)
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
|
@ -685,6 +685,21 @@ class User < Owner
|
|||
raise text
|
||||
end
|
||||
|
||||
def self.authenticate!(login, password)
|
||||
user = self.where("login = ? or mail = ? or phone = ? ", login.to_s.gsub(" ",''),login.to_s.gsub(" ",''),login.downcase.to_s.gsub(" ",'')).limit(1).first
|
||||
return (user.check_password?(password) ? user : nil) unless user.nil?
|
||||
nil
|
||||
end
|
||||
|
||||
# Generate public/private keys
|
||||
def generate_keys
|
||||
key_size = (Rails.env == 'test' ? 512 : 2048)
|
||||
|
||||
serialized_private_key = OpenSSL::PKey::RSA::generate(key_size).to_s
|
||||
serialized_public_key = OpenSSL::PKey::RSA.new(serialized_private_key)
|
||||
[serialized_private_key, serialized_public_key]
|
||||
end
|
||||
|
||||
def show_real_name
|
||||
name = lastname + firstname
|
||||
if name.blank?
|
||||
|
|
|
|||
|
|
@ -0,0 +1,76 @@
|
|||
class Projects::LinkJoinService < ApplicationService
|
||||
Error = Class.new(StandardError)
|
||||
|
||||
attr_reader :user, :project, :invite_sign, :params
|
||||
|
||||
def initialize(user, project, invite_sign, params={})
|
||||
@user = user
|
||||
@project = project
|
||||
@invite_sign = invite_sign
|
||||
@params = params
|
||||
end
|
||||
|
||||
def call
|
||||
ActiveRecord::Base.transaction do
|
||||
validate!
|
||||
if invite_link.is_apply
|
||||
# 如果需要申请才能加入，创建一条申请记录
|
||||
create_applied_project!
|
||||
else
|
||||
# 如果不需要申请，直接为项目添加该成员
|
||||
create_member!
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def validate!
|
||||
raise Error, 'invite_sign必须存在!' if invite_sign.blank?
|
||||
raise Error, '邀请链接不存在!' unless invite_link.present?
|
||||
raise Error, '邀请链接已失效!' unless invite_user_in_project
|
||||
raise Error, '用户已加入该项目!' if project.member?(user.id)
|
||||
end
|
||||
|
||||
def create_applied_project!
|
||||
user.applied_projects.create!(project: project, role: role_value, project_invite_link_id: invite_link&.id)
|
||||
end
|
||||
|
||||
def create_member!
|
||||
Projects::AddMemberInteractor.call(project.owner, project, user, permission)
|
||||
end
|
||||
|
||||
def invite_link
|
||||
ProjectInviteLink.find_by(project_id: project.id, sign: invite_sign)
|
||||
end
|
||||
|
||||
def invite_user_in_project
|
||||
in_project = project.member?(invite_link.user)
|
||||
invite_link.update_column(:expired_at, Time.now) unless in_project
|
||||
in_project
|
||||
end
|
||||
|
||||
def role_value
|
||||
@_role ||=
|
||||
case invite_link&.role
|
||||
when 'manager' then 3
|
||||
when 'developer' then 4
|
||||
when 'reporter' then 5
|
||||
else
|
||||
5
|
||||
end
|
||||
end
|
||||
|
||||
def permission
|
||||
case invite_link&.role
|
||||
when 'manager'
|
||||
'admin'
|
||||
when 'developer'
|
||||
'write'
|
||||
when 'reporter'
|
||||
'read'
|
||||
else
|
||||
'read'
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
json.id project.id
|
||||
json.identifier project.identifier
|
||||
json.name project.name
|
||||
json.description project.description
|
||||
json.is_public project.is_public
|
||||
json.owner do
|
||||
json.partial! "/users/user_simple", locals: {user: project.owner}
|
||||
end
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
json.(project_invite_link, :id, :role, :is_apply, :sign)
|
||||
json.expired_at format_time(project_invite_link&.expired_at)
|
||||
json.user do
|
||||
json.partial! "/users/user_simple", locals: {user: project_invite_link.user}
|
||||
end
|
||||
if project_invite_link&.project.present?
|
||||
json.project do
|
||||
json.partial! "/projects/detail", locals: {project: project_invite_link.project}
|
||||
end
|
||||
else
|
||||
json.project nil
|
||||
end
|
||||
|
|
@ -0,0 +1 @@
|
|||
json.partial! 'detail', locals: { project_invite_link: @project_invite_link }
|
||||
|
|
@ -0,0 +1 @@
|
|||
json.partial! 'detail', locals: { project_invite_link: @project_invite_link }
|
||||
|
|
@ -0,0 +1 @@
|
|||
json.partial! 'detail', locals: { project_invite_link: @project_invite_link }
|
||||
|
|
@ -0,0 +1,556 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
Doorkeeper.configure do
|
||||
# Change the ORM that doorkeeper will use (requires ORM extensions installed).
|
||||
# Check the list of supported ORMs here: https://github.com/doorkeeper-gem/doorkeeper#orms
|
||||
orm :active_record
|
||||
|
||||
# This block will be called to check whether the resource owner is authenticated or not.
|
||||
resource_owner_authenticator do
|
||||
# raise "Please configure doorkeeper resource_owner_authenticator block located in #{__FILE__}"
|
||||
# Put your resource owner authentication logic here.
|
||||
# Example implementation:
|
||||
User.find_by(id: session[:www_user_id]) || redirect_to(new_user_session_url)
|
||||
end
|
||||
|
||||
resource_owner_from_credentials do |routes|
|
||||
User.authenticate!(params[:username], params[:password])
|
||||
end
|
||||
|
||||
access_token_generator '::Doorkeeper::JWT'
|
||||
|
||||
admin_authenticator do
|
||||
user = User.find_by_id(session[:www_user_id])
|
||||
unless user #&& user.admin_or_business?
|
||||
redirect_to root_url
|
||||
end
|
||||
end
|
||||
|
||||
# If you didn't skip applications controller from Doorkeeper routes in your application routes.rb
|
||||
# file then you need to declare this block in order to restrict access to the web interface for
|
||||
# adding oauth authorized applications. In other case it will return 403 Forbidden response
|
||||
# every time somebody will try to access the admin web interface.
|
||||
#
|
||||
# admin_authenticator do
|
||||
# # Put your admin authentication logic here.
|
||||
# # Example implementation:
|
||||
#
|
||||
# if current_user
|
||||
# head :forbidden unless current_user.admin?
|
||||
# else
|
||||
# redirect_to sign_in_url
|
||||
# end
|
||||
# end
|
||||
|
||||
# You can use your own model classes if you need to extend (or even override) default
|
||||
# Doorkeeper models such as `Application`, `AccessToken` and `AccessGrant.
|
||||
#
|
||||
# Be default Doorkeeper ActiveRecord ORM uses it's own classes:
|
||||
#
|
||||
# access_token_class "Doorkeeper::AccessToken"
|
||||
# access_grant_class "Doorkeeper::AccessGrant"
|
||||
# application_class "Doorkeeper::Application"
|
||||
#
|
||||
# Don't forget to include Doorkeeper ORM mixins into your custom models:
|
||||
#
|
||||
# * ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken - for access token
|
||||
# * ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessGrant - for access grant
|
||||
# * ::Doorkeeper::Orm::ActiveRecord::Mixins::Application - for application (OAuth2 clients)
|
||||
#
|
||||
# For example:
|
||||
#
|
||||
# access_token_class "MyAccessToken"
|
||||
#
|
||||
# class MyAccessToken < ApplicationRecord
|
||||
# include ::Doorkeeper::Orm::ActiveRecord::Mixins::AccessToken
|
||||
#
|
||||
# self.table_name = "hey_i_wanna_my_name"
|
||||
#
|
||||
# def destroy_me!
|
||||
# destroy
|
||||
# end
|
||||
# end
|
||||
|
||||
# Enables polymorphic Resource Owner association for Access Tokens and Access Grants.
|
||||
# By default this option is disabled.
|
||||
#
|
||||
# Make sure you properly setup you database and have all the required columns (run
|
||||
# `bundle exec rails generate doorkeeper:enable_polymorphic_resource_owner` and execute Rails
|
||||
# migrations).
|
||||
#
|
||||
# If this option enabled, Doorkeeper will store not only Resource Owner primary key
|
||||
# value, but also it's type (class name). See "Polymorphic Associations" section of
|
||||
# Rails guides: https://guides.rubyonrails.org/association_basics.html#polymorphic-associations
|
||||
#
|
||||
# [NOTE] If you apply this option on already existing project don't forget to manually
|
||||
# update `resource_owner_type` column in the database and fix migration template as it will
|
||||
# set NOT NULL constraint for Access Grants table.
|
||||
#
|
||||
# use_polymorphic_resource_owner
|
||||
|
||||
# If you are planning to use Doorkeeper in Rails 5 API-only application, then you might
|
||||
# want to use API mode that will skip all the views management and change the way how
|
||||
# Doorkeeper responds to a requests.
|
||||
#
|
||||
# api_only
|
||||
|
||||
# Enforce token request content type to application/x-www-form-urlencoded.
|
||||
# It is not enabled by default to not break prior versions of the gem.
|
||||
#
|
||||
# enforce_content_type
|
||||
|
||||
# Authorization Code expiration time (default: 10 minutes).
|
||||
#
|
||||
# authorization_code_expires_in 10.minutes
|
||||
|
||||
# Access token expiration time (default: 2 hours).
|
||||
# If you want to disable expiration, set this to `nil`.
|
||||
#
|
||||
# access_token_expires_in 2.hours
|
||||
|
||||
# Assign custom TTL for access tokens. Will be used instead of access_token_expires_in
|
||||
# option if defined. In case the block returns `nil` value Doorkeeper fallbacks to
|
||||
# +access_token_expires_in+ configuration option value. If you really need to issue a
|
||||
# non-expiring access token (which is not recommended) then you need to return
|
||||
# Float::INFINITY from this block.
|
||||
#
|
||||
# `context` has the following properties available:
|
||||
#
|
||||
# * `client` - the OAuth client application (see Doorkeeper::OAuth::Client)
|
||||
# * `grant_type` - the grant type of the request (see Doorkeeper::OAuth)
|
||||
# * `scopes` - the requested scopes (see Doorkeeper::OAuth::Scopes)
|
||||
# * `resource_owner` - authorized resource owner instance (if present)
|
||||
#
|
||||
# custom_access_token_expires_in do |context|
|
||||
# context.client.additional_settings.implicit_oauth_expiration
|
||||
# end
|
||||
|
||||
# Use a custom class for generating the access token.
|
||||
# See https://doorkeeper.gitbook.io/guides/configuration/other-configurations#custom-access-token-generator
|
||||
#
|
||||
# access_token_generator '::Doorkeeper::JWT'
|
||||
|
||||
# The controller +Doorkeeper::ApplicationController+ inherits from.
|
||||
# Defaults to +ActionController::Base+ unless +api_only+ is set, which changes the default to
|
||||
# +ActionController::API+. The return value of this option must be a stringified class name.
|
||||
# See https://doorkeeper.gitbook.io/guides/configuration/other-configurations#custom-controllers
|
||||
#
|
||||
# base_controller 'ApplicationController'
|
||||
|
||||
# Reuse access token for the same resource owner within an application (disabled by default).
|
||||
#
|
||||
# This option protects your application from creating new tokens before old valid one becomes
|
||||
# expired so your database doesn't bloat. Keep in mind that when this option is `on` Doorkeeper
|
||||
# doesn't updates existing token expiration time, it will create a new token instead.
|
||||
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
|
||||
#
|
||||
# You can not enable this option together with +hash_token_secrets+.
|
||||
#
|
||||
# reuse_access_token
|
||||
|
||||
# In case you enabled `reuse_access_token` option Doorkeeper will try to find matching
|
||||
# token using `matching_token_for` Access Token API that searches for valid records
|
||||
# in batches in order not to pollute the memory with all the database records. By default
|
||||
# Doorkeeper uses batch size of 10 000 records. You can increase or decrease this value
|
||||
# depending on your needs and server capabilities.
|
||||
#
|
||||
# token_lookup_batch_size 10_000
|
||||
|
||||
# Set a limit for token_reuse if using reuse_access_token option
|
||||
#
|
||||
# This option limits token_reusability to some extent.
|
||||
# If not set then access_token will be reused unless it expires.
|
||||
# Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/1189
|
||||
#
|
||||
# This option should be a percentage(i.e. (0,100])
|
||||
#
|
||||
# token_reuse_limit 100
|
||||
|
||||
# Only allow one valid access token obtained via client credentials
|
||||
# per client. If a new access token is obtained before the old one
|
||||
# expired, the old one gets revoked (disabled by default)
|
||||
#
|
||||
# When enabling this option, make sure that you do not expect multiple processes
|
||||
# using the same credentials at the same time (e.g. web servers spanning
|
||||
# multiple machines and/or processes).
|
||||
#
|
||||
# revoke_previous_client_credentials_token
|
||||
|
||||
# Hash access and refresh tokens before persisting them.
|
||||
# This will disable the possibility to use +reuse_access_token+
|
||||
# since plain values can no longer be retrieved.
|
||||
#
|
||||
# Note: If you are already a user of doorkeeper and have existing tokens
|
||||
# in your installation, they will be invalid without adding 'fallback: :plain'.
|
||||
#
|
||||
# hash_token_secrets
|
||||
# By default, token secrets will be hashed using the
|
||||
# +Doorkeeper::Hashing::SHA256+ strategy.
|
||||
#
|
||||
# If you wish to use another hashing implementation, you can override
|
||||
# this strategy as follows:
|
||||
#
|
||||
# hash_token_secrets using: '::Doorkeeper::Hashing::MyCustomHashImpl'
|
||||
#
|
||||
# Keep in mind that changing the hashing function will invalidate all existing
|
||||
# secrets, if there are any.
|
||||
|
||||
# Hash application secrets before persisting them.
|
||||
#
|
||||
# hash_application_secrets
|
||||
#
|
||||
# By default, applications will be hashed
|
||||
# with the +Doorkeeper::SecretStoring::SHA256+ strategy.
|
||||
#
|
||||
# If you wish to use bcrypt for application secret hashing, uncomment
|
||||
# this line instead:
|
||||
#
|
||||
# hash_application_secrets using: '::Doorkeeper::SecretStoring::BCrypt'
|
||||
|
||||
# When the above option is enabled, and a hashed token or secret is not found,
|
||||
# you can allow to fall back to another strategy. For users upgrading
|
||||
# doorkeeper and wishing to enable hashing, you will probably want to enable
|
||||
# the fallback to plain tokens.
|
||||
#
|
||||
# This will ensure that old access tokens and secrets
|
||||
# will remain valid even if the hashing above is enabled.
|
||||
#
|
||||
# This can be done by adding 'fallback: plain', e.g. :
|
||||
#
|
||||
# hash_application_secrets using: '::Doorkeeper::SecretStoring::BCrypt', fallback: :plain
|
||||
|
||||
# Issue access tokens with refresh token (disabled by default), you may also
|
||||
# pass a block which accepts `context` to customize when to give a refresh
|
||||
# token or not. Similar to +custom_access_token_expires_in+, `context` has
|
||||
# the following properties:
|
||||
#
|
||||
# `client` - the OAuth client application (see Doorkeeper::OAuth::Client)
|
||||
# `grant_type` - the grant type of the request (see Doorkeeper::OAuth)
|
||||
# `scopes` - the requested scopes (see Doorkeeper::OAuth::Scopes)
|
||||
#
|
||||
use_refresh_token
|
||||
|
||||
# Provide support for an owner to be assigned to each registered application (disabled by default)
|
||||
# Optional parameter confirmation: true (default: false) if you want to enforce ownership of
|
||||
# a registered application
|
||||
# NOTE: you must also run the rails g doorkeeper:application_owner generator
|
||||
# to provide the necessary support
|
||||
#
|
||||
# enable_application_owner confirmation: false
|
||||
|
||||
# Define access token scopes for your provider
|
||||
# For more information go to
|
||||
# https://doorkeeper.gitbook.io/guides/ruby-on-rails/scopes
|
||||
#
|
||||
# default_scopes :public
|
||||
# optional_scopes :write, :update
|
||||
|
||||
# Allows to restrict only certain scopes for grant_type.
|
||||
# By default, all the scopes will be available for all the grant types.
|
||||
#
|
||||
# Keys to this hash should be the name of grant_type and
|
||||
# values should be the array of scopes for that grant type.
|
||||
# Note: scopes should be from configured_scopes (i.e. default or optional)
|
||||
#
|
||||
# scopes_by_grant_type password: [:write], client_credentials: [:update]
|
||||
|
||||
# Forbids creating/updating applications with arbitrary scopes that are
|
||||
# not in configuration, i.e. +default_scopes+ or +optional_scopes+.
|
||||
# (disabled by default)
|
||||
#
|
||||
# enforce_configured_scopes
|
||||
|
||||
# Change the way client credentials are retrieved from the request object.
|
||||
# By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
|
||||
# falls back to the `:client_id` and `:client_secret` params from the `params` object.
|
||||
# Check out https://github.com/doorkeeper-gem/doorkeeper/wiki/Changing-how-clients-are-authenticated
|
||||
# for more information on customization
|
||||
#
|
||||
# client_credentials :from_basic, :from_params
|
||||
|
||||
# Change the way access token is authenticated from the request object.
|
||||
# By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
|
||||
# falls back to the `:access_token` or `:bearer_token` params from the `params` object.
|
||||
# Check out https://github.com/doorkeeper-gem/doorkeeper/wiki/Changing-how-clients-are-authenticated
|
||||
# for more information on customization
|
||||
#
|
||||
# access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
|
||||
|
||||
# Forces the usage of the HTTPS protocol in non-native redirect uris (enabled
|
||||
# by default in non-development environments). OAuth2 delegates security in
|
||||
# communication to the HTTPS protocol so it is wise to keep this enabled.
|
||||
#
|
||||
# Callable objects such as proc, lambda, block or any object that responds to
|
||||
# #call can be used in order to allow conditional checks (to allow non-SSL
|
||||
# redirects to localhost for example).
|
||||
#
|
||||
# force_ssl_in_redirect_uri !Rails.env.development?
|
||||
#
|
||||
# force_ssl_in_redirect_uri { |uri| uri.host != 'localhost' }
|
||||
|
||||
# Specify what redirect URI's you want to block during Application creation.
|
||||
# Any redirect URI is allowed by default.
|
||||
#
|
||||
# You can use this option in order to forbid URI's with 'javascript' scheme
|
||||
# for example.
|
||||
#
|
||||
# forbid_redirect_uri { |uri| uri.scheme.to_s.downcase == 'javascript' }
|
||||
|
||||
# Allows to set blank redirect URIs for Applications in case Doorkeeper configured
|
||||
# to use URI-less OAuth grant flows like Client Credentials or Resource Owner
|
||||
# Password Credentials. The option is on by default and checks configured grant
|
||||
# types, but you **need** to manually drop `NOT NULL` constraint from `redirect_uri`
|
||||
# column for `oauth_applications` database table.
|
||||
#
|
||||
# You can completely disable this feature with:
|
||||
#
|
||||
allow_blank_redirect_uri true
|
||||
#
|
||||
# Or you can define your custom check:
|
||||
#
|
||||
# allow_blank_redirect_uri do |grant_flows, client|
|
||||
# client.superapp?
|
||||
# end
|
||||
|
||||
# Specify how authorization errors should be handled.
|
||||
# By default, doorkeeper renders json errors when access token
|
||||
# is invalid, expired, revoked or has invalid scopes.
|
||||
#
|
||||
# If you want to render error response yourself (i.e. rescue exceptions),
|
||||
# set +handle_auth_errors+ to `:raise` and rescue Doorkeeper::Errors::InvalidToken
|
||||
# or following specific errors:
|
||||
#
|
||||
# Doorkeeper::Errors::TokenForbidden, Doorkeeper::Errors::TokenExpired,
|
||||
# Doorkeeper::Errors::TokenRevoked, Doorkeeper::Errors::TokenUnknown
|
||||
#
|
||||
# handle_auth_errors :raise
|
||||
|
||||
# Customize token introspection response.
|
||||
# Allows to add your own fields to default one that are required by the OAuth spec
|
||||
# for the introspection response. It could be `sub`, `aud` and so on.
|
||||
# This configuration option can be a proc, lambda or any Ruby object responds
|
||||
# to `.call` method and result of it's invocation must be a Hash.
|
||||
#
|
||||
# custom_introspection_response do |token, context|
|
||||
# {
|
||||
# "sub": "Z5O3upPC88QrAjx00dis",
|
||||
# "aud": "https://protected.example.net/resource",
|
||||
# "username": User.find(token.resource_owner_id).username
|
||||
# }
|
||||
# end
|
||||
#
|
||||
# or
|
||||
#
|
||||
# custom_introspection_response CustomIntrospectionResponder
|
||||
|
||||
# Specify what grant flows are enabled in array of Strings. The valid
|
||||
# strings and the flows they enable are:
|
||||
#
|
||||
# "authorization_code" => Authorization Code Grant Flow
|
||||
# "implicit" => Implicit Grant Flow
|
||||
# "password" => Resource Owner Password Credentials Grant Flow
|
||||
# "client_credentials" => Client Credentials Grant Flow
|
||||
#
|
||||
# If not specified, Doorkeeper enables authorization_code and
|
||||
# client_credentials.
|
||||
#
|
||||
# implicit and password grant flows have risks that you should understand
|
||||
# before enabling:
|
||||
# https://datatracker.ietf.org/doc/html/rfc6819#section-4.4.2
|
||||
# https://datatracker.ietf.org/doc/html/rfc6819#section-4.4.3
|
||||
#
|
||||
#
|
||||
grant_flows %w[authorization_code client_credentials password]
|
||||
|
||||
# Allows to customize OAuth grant flows that +each+ application support.
|
||||
# You can configure a custom block (or use a class respond to `#call`) that must
|
||||
# return `true` in case Application instance supports requested OAuth grant flow
|
||||
# during the authorization request to the server. This configuration +doesn't+
|
||||
# set flows per application, it only allows to check if application supports
|
||||
# specific grant flow.
|
||||
#
|
||||
# For example you can add an additional database column to `oauth_applications` table,
|
||||
# say `t.array :grant_flows, default: []`, and store allowed grant flows that can
|
||||
# be used with this application there. Then when authorization requested Doorkeeper
|
||||
# will call this block to check if specific Application (passed with client_id and/or
|
||||
# client_secret) is allowed to perform the request for the specific grant type
|
||||
# (authorization, password, client_credentials, etc).
|
||||
#
|
||||
# Example of the block:
|
||||
#
|
||||
# ->(flow, client) { client.grant_flows.include?(flow) }
|
||||
#
|
||||
# In case this option invocation result is `false`, Doorkeeper server returns
|
||||
# :unauthorized_client error and stops the request.
|
||||
#
|
||||
# @param allow_grant_flow_for_client [Proc] Block or any object respond to #call
|
||||
# @return [Boolean] `true` if allow or `false` if forbid the request
|
||||
#
|
||||
# allow_grant_flow_for_client do |grant_flow, client|
|
||||
# # `grant_flows` is an Array column with grant
|
||||
# # flows that application supports
|
||||
#
|
||||
# client.grant_flows.include?(grant_flow)
|
||||
# end
|
||||
|
||||
# If you need arbitrary Resource Owner-Client authorization you can enable this option
|
||||
# and implement the check your need. Config option must respond to #call and return
|
||||
# true in case resource owner authorized for the specific application or false in other
|
||||
# cases.
|
||||
#
|
||||
# Be default all Resource Owners are authorized to any Client (application).
|
||||
#
|
||||
# authorize_resource_owner_for_client do |client, resource_owner|
|
||||
# resource_owner.admin? || client.owners_allowlist.include?(resource_owner)
|
||||
# end
|
||||
|
||||
# Hook into the strategies' request & response life-cycle in case your
|
||||
# application needs advanced customization or logging:
|
||||
#
|
||||
# before_successful_strategy_response do |request|
|
||||
# puts "BEFORE HOOK FIRED! #{request}"
|
||||
# end
|
||||
#
|
||||
# after_successful_strategy_response do |request, response|
|
||||
# puts "AFTER HOOK FIRED! #{request}, #{response}"
|
||||
# end
|
||||
|
||||
# Hook into Authorization flow in order to implement Single Sign Out
|
||||
# or add any other functionality. Inside the block you have an access
|
||||
# to `controller` (authorizations controller instance) and `context`
|
||||
# (Doorkeeper::OAuth::Hooks::Context instance) which provides pre auth
|
||||
# or auth objects with issued token based on hook type (before or after).
|
||||
#
|
||||
# before_successful_authorization do |controller, context|
|
||||
# Rails.logger.info(controller.request.params.inspect)
|
||||
#
|
||||
# Rails.logger.info(context.pre_auth.inspect)
|
||||
# end
|
||||
#
|
||||
# after_successful_authorization do |controller, context|
|
||||
# controller.session[:logout_urls] <<
|
||||
# Doorkeeper::Application
|
||||
# .find_by(controller.request.params.slice(:redirect_uri))
|
||||
# .logout_uri
|
||||
#
|
||||
# Rails.logger.info(context.auth.inspect)
|
||||
# Rails.logger.info(context.issued_token)
|
||||
# end
|
||||
|
||||
# Under some circumstances you might want to have applications auto-approved,
|
||||
# so that the user skips the authorization step.
|
||||
# For example if dealing with a trusted application.
|
||||
#
|
||||
# skip_authorization do |resource_owner, client|
|
||||
# client.superapp? or resource_owner.admin?
|
||||
# end
|
||||
skip_authorization do
|
||||
true
|
||||
end
|
||||
|
||||
# Configure custom constraints for the Token Introspection request.
|
||||
# By default this configuration option allows to introspect a token by another
|
||||
# token of the same application, OR to introspect the token that belongs to
|
||||
# authorized client (from authenticated client) OR when token doesn't
|
||||
# belong to any client (public token). Otherwise requester has no access to the
|
||||
# introspection and it will return response as stated in the RFC.
|
||||
#
|
||||
# Block arguments:
|
||||
#
|
||||
# @param token [Doorkeeper::AccessToken]
|
||||
# token to be introspected
|
||||
#
|
||||
# @param authorized_client [Doorkeeper::Application]
|
||||
# authorized client (if request is authorized using Basic auth with
|
||||
# Client Credentials for example)
|
||||
#
|
||||
# @param authorized_token [Doorkeeper::AccessToken]
|
||||
# Bearer token used to authorize the request
|
||||
#
|
||||
# In case the block returns `nil` or `false` introspection responses with 401 status code
|
||||
# when using authorized token to introspect, or you'll get 200 with { "active": false } body
|
||||
# when using authorized client to introspect as stated in the
|
||||
# RFC 7662 section 2.2. Introspection Response.
|
||||
#
|
||||
# Using with caution:
|
||||
# Keep in mind that these three parameters pass to block can be nil as following case:
|
||||
# `authorized_client` is nil if and only if `authorized_token` is present, and vice versa.
|
||||
# `token` will be nil if and only if `authorized_token` is present.
|
||||
# So remember to use `&` or check if it is present before calling method on
|
||||
# them to make sure you doesn't get NoMethodError exception.
|
||||
#
|
||||
# You can define your custom check:
|
||||
#
|
||||
# allow_token_introspection do |token, authorized_client, authorized_token|
|
||||
# if authorized_token
|
||||
# # customize: require `introspection` scope
|
||||
# authorized_token.application == token&.application ||
|
||||
# authorized_token.scopes.include?("introspection")
|
||||
# elsif token.application
|
||||
# # `protected_resource` is a new database boolean column, for example
|
||||
# authorized_client == token.application || authorized_client.protected_resource?
|
||||
# else
|
||||
# # public token (when token.application is nil, token doesn't belong to any application)
|
||||
# true
|
||||
# end
|
||||
# end
|
||||
#
|
||||
# Or you can completely disable any token introspection:
|
||||
#
|
||||
# allow_token_introspection false
|
||||
#
|
||||
# If you need to block the request at all, then configure your routes.rb or web-server
|
||||
# like nginx to forbid the request.
|
||||
|
||||
# WWW-Authenticate Realm (default: "Doorkeeper").
|
||||
#
|
||||
# realm "Doorkeeper"
|
||||
end
|
||||
|
||||
|
||||
Doorkeeper::JWT.configure do
|
||||
# Set the payload for the JWT token. This should contain unique information
|
||||
# about the user. Defaults to a randomly generated token in a hash:
|
||||
# { token: "RANDOM-TOKEN" }
|
||||
token_payload do |opts|
|
||||
user = User.find(opts[:resource_owner_id])
|
||||
|
||||
{
|
||||
iss: 'My App',
|
||||
iat: Time.current.utc.to_i,
|
||||
|
||||
# @see JWT reserved claims - https://tools.ietf.org/html/draft-jones-json-web-token-07#page-7
|
||||
jti: SecureRandom.uuid,
|
||||
|
||||
user: {
|
||||
id: user.id,
|
||||
login: user.login,
|
||||
mail: user.mail
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
# Optionally set additional headers for the JWT. See
|
||||
# https://tools.ietf.org/html/rfc7515#section-4.1
|
||||
token_headers do |opts|
|
||||
{ kid: opts[:application][:uid] }
|
||||
end
|
||||
|
||||
# Use the application secret specified in the access grant token. Defaults to
|
||||
# `false`. If you specify `use_application_secret true`, both `secret_key` and
|
||||
# `secret_key_path` will be ignored.
|
||||
use_application_secret false
|
||||
|
||||
# Set the encryption secret. This would be shared with any other applications
|
||||
# that should be able to read the payload of the token. Defaults to "secret".
|
||||
secret_key ENV['JWT_SECRET'] || "forgeplus"
|
||||
|
||||
# If you want to use RS* encoding specify the path to the RSA key to use for
|
||||
# signing. If you specify a `secret_key_path` it will be used instead of
|
||||
# `secret_key`.
|
||||
secret_key_path File.join('path', 'to', 'file.pem')
|
||||
|
||||
# Specify encryption type (https://github.com/progrium/ruby-jwt). Defaults to
|
||||
# `nil`.
|
||||
encryption_method :hs512
|
||||
end
|
||||
|
|
@ -0,0 +1,151 @@
|
|||
en:
|
||||
activerecord:
|
||||
attributes:
|
||||
doorkeeper/application:
|
||||
name: 'Name'
|
||||
redirect_uri: 'Redirect URI'
|
||||
errors:
|
||||
models:
|
||||
doorkeeper/application:
|
||||
attributes:
|
||||
redirect_uri:
|
||||
fragment_present: 'cannot contain a fragment.'
|
||||
invalid_uri: 'must be a valid URI.'
|
||||
unspecified_scheme: 'must specify a scheme.'
|
||||
relative_uri: 'must be an absolute URI.'
|
||||
secured_uri: 'must be an HTTPS/SSL URI.'
|
||||
forbidden_uri: 'is forbidden by the server.'
|
||||
scopes:
|
||||
not_match_configured: "doesn't match configured on the server."
|
||||
|
||||
doorkeeper:
|
||||
applications:
|
||||
confirmations:
|
||||
destroy: 'Are you sure?'
|
||||
buttons:
|
||||
edit: 'Edit'
|
||||
destroy: 'Destroy'
|
||||
submit: 'Submit'
|
||||
cancel: 'Cancel'
|
||||
authorize: 'Authorize'
|
||||
form:
|
||||
error: 'Whoops! Check your form for possible errors'
|
||||
help:
|
||||
confidential: 'Application will be used where the client secret can be kept confidential. Native mobile apps and Single Page Apps are considered non-confidential.'
|
||||
redirect_uri: 'Use one line per URI'
|
||||
blank_redirect_uri: "Leave it blank if you configured your provider to use Client Credentials, Resource Owner Password Credentials or any other grant type that doesn't require redirect URI."
|
||||
scopes: 'Separate scopes with spaces. Leave blank to use the default scopes.'
|
||||
edit:
|
||||
title: 'Edit application'
|
||||
index:
|
||||
title: 'Your applications'
|
||||
new: 'New Application'
|
||||
name: 'Name'
|
||||
callback_url: 'Callback URL'
|
||||
confidential: 'Confidential?'
|
||||
actions: 'Actions'
|
||||
confidentiality:
|
||||
'yes': 'Yes'
|
||||
'no': 'No'
|
||||
new:
|
||||
title: 'New Application'
|
||||
show:
|
||||
title: 'Application: %{name}'
|
||||
application_id: 'UID'
|
||||
secret: 'Secret'
|
||||
secret_hashed: 'Secret hashed'
|
||||
scopes: 'Scopes'
|
||||
confidential: 'Confidential'
|
||||
callback_urls: 'Callback urls'
|
||||
actions: 'Actions'
|
||||
not_defined: 'Not defined'
|
||||
|
||||
authorizations:
|
||||
buttons:
|
||||
authorize: 'Authorize'
|
||||
deny: 'Deny'
|
||||
error:
|
||||
title: 'An error has occurred'
|
||||
new:
|
||||
title: 'Authorization required'
|
||||
prompt: 'Authorize %{client_name} to use your account?'
|
||||
able_to: 'This application will be able to'
|
||||
show:
|
||||
title: 'Authorization code'
|
||||
form_post:
|
||||
title: 'Submit this form'
|
||||
|
||||
authorized_applications:
|
||||
confirmations:
|
||||
revoke: 'Are you sure?'
|
||||
buttons:
|
||||
revoke: 'Revoke'
|
||||
index:
|
||||
title: 'Your authorized applications'
|
||||
application: 'Application'
|
||||
created_at: 'Created At'
|
||||
date_format: '%Y-%m-%d %H:%M:%S'
|
||||
|
||||
pre_authorization:
|
||||
status: 'Pre-authorization'
|
||||
|
||||
errors:
|
||||
messages:
|
||||
# Common error messages
|
||||
invalid_request:
|
||||
unknown: 'The request is missing a required parameter, includes an unsupported parameter value, or is otherwise malformed.'
|
||||
missing_param: 'Missing required parameter: %{value}.'
|
||||
request_not_authorized: 'Request need to be authorized. Required parameter for authorizing request is missing or invalid.'
|
||||
invalid_redirect_uri: "The requested redirect uri is malformed or doesn't match client redirect URI."
|
||||
unauthorized_client: 'The client is not authorized to perform this request using this method.'
|
||||
access_denied: 'The resource owner or authorization server denied the request.'
|
||||
invalid_scope: 'The requested scope is invalid, unknown, or malformed.'
|
||||
invalid_code_challenge_method: 'The code challenge method must be plain or S256.'
|
||||
server_error: 'The authorization server encountered an unexpected condition which prevented it from fulfilling the request.'
|
||||
temporarily_unavailable: 'The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.'
|
||||
|
||||
# Configuration error messages
|
||||
credential_flow_not_configured: 'Resource Owner Password Credentials flow failed due to Doorkeeper.configure.resource_owner_from_credentials being unconfigured.'
|
||||
resource_owner_authenticator_not_configured: 'Resource Owner find failed due to Doorkeeper.configure.resource_owner_authenticator being unconfigured.'
|
||||
admin_authenticator_not_configured: 'Access to admin panel is forbidden due to Doorkeeper.configure.admin_authenticator being unconfigured.'
|
||||
|
||||
# Access grant errors
|
||||
unsupported_response_type: 'The authorization server does not support this response type.'
|
||||
unsupported_response_mode: 'The authorization server does not support this response mode.'
|
||||
|
||||
# Access token errors
|
||||
invalid_client: 'Client authentication failed due to unknown client, no client authentication included, or unsupported authentication method.'
|
||||
invalid_grant: 'The provided authorization grant is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.'
|
||||
unsupported_grant_type: 'The authorization grant type is not supported by the authorization server.'
|
||||
|
||||
invalid_token:
|
||||
revoked: "The access token was revoked"
|
||||
expired: "The access token expired"
|
||||
unknown: "The access token is invalid"
|
||||
revoke:
|
||||
unauthorized: "You are not authorized to revoke this token"
|
||||
|
||||
forbidden_token:
|
||||
missing_scope: 'Access to this resource requires scope "%{oauth_scopes}".'
|
||||
|
||||
flash:
|
||||
applications:
|
||||
create:
|
||||
notice: 'Application created.'
|
||||
destroy:
|
||||
notice: 'Application deleted.'
|
||||
update:
|
||||
notice: 'Application updated.'
|
||||
authorized_applications:
|
||||
destroy:
|
||||
notice: 'Application revoked.'
|
||||
|
||||
layouts:
|
||||
admin:
|
||||
title: 'Doorkeeper'
|
||||
nav:
|
||||
oauth2_provider: 'OAuth2 Provider'
|
||||
applications: 'Applications'
|
||||
home: 'Home'
|
||||
application:
|
||||
title: 'OAuth authorization required'
|
||||
|
|
@ -0,0 +1,135 @@
|
|||
zh-CN:
|
||||
activerecord:
|
||||
attributes:
|
||||
doorkeeper/application:
|
||||
name: 应用名称
|
||||
redirect_uri: 重定向 URI
|
||||
errors:
|
||||
models:
|
||||
doorkeeper/application:
|
||||
attributes:
|
||||
redirect_uri:
|
||||
fragment_present: 不能包含网址片段（#）
|
||||
invalid_uri: 必须是有效的 URI 格式
|
||||
unspecified_scheme: must specify a scheme.
|
||||
relative_uri: 必须是绝对的 URI 地址
|
||||
secured_uri: 必须是 HTTPS/SSL 的 URI 地址
|
||||
forbidden_uri: 被服务器禁止。
|
||||
scopes:
|
||||
not_match_configured: 不匹配服务器上的配置。
|
||||
doorkeeper:
|
||||
applications:
|
||||
confirmations:
|
||||
destroy: 确定要删除应用吗？
|
||||
buttons:
|
||||
edit: 编辑
|
||||
destroy: 删除
|
||||
submit: 提交
|
||||
cancel: 取消
|
||||
authorize: 授权
|
||||
form:
|
||||
error: 抱歉! 提交信息的时候遇到了下面的错误
|
||||
help:
|
||||
confidential: 应用程序的client secret可以保密，但原生移动应用和单页应用将无法保护client secret。
|
||||
redirect_uri: 每行只能有一个 URI
|
||||
blank_redirect_uri: Leave it blank if you configured your provider to use Client Credentials, Resource Owner Password Credentials or any other grant type that doesn't require redirect URI.
|
||||
scopes: 用空格分割权限范围，留空则使用默认设置
|
||||
edit:
|
||||
title: 修改应用
|
||||
index:
|
||||
title: 你的应用
|
||||
new: 创建新应用
|
||||
name: 名称
|
||||
callback_url: 回调 URL
|
||||
confidential: Confidential?
|
||||
actions: 动作
|
||||
confidentiality:
|
||||
'yes': 是
|
||||
'no': 沒有
|
||||
new:
|
||||
title: 创建新应用
|
||||
show:
|
||||
title: 应用：%{name}
|
||||
application_id: 应用 UID
|
||||
secret: 应用密钥
|
||||
secret_hashed: Secret hashed
|
||||
scopes: 权限范围
|
||||
confidential: Confidential
|
||||
callback_urls: 回调 URL
|
||||
actions: 操作
|
||||
not_defined: Not defined
|
||||
authorizations:
|
||||
buttons:
|
||||
authorize: 同意授权
|
||||
deny: 拒绝授权
|
||||
error:
|
||||
title: 发生错误
|
||||
new:
|
||||
title: 需要授权
|
||||
prompt: 授权 %{client_name} 使用你的帐户？
|
||||
able_to: 此应用将能够
|
||||
show:
|
||||
title: 授权代码
|
||||
form_post:
|
||||
title: Submit this form
|
||||
authorized_applications:
|
||||
confirmations:
|
||||
revoke: 确定要撤销对此应用的授权吗？
|
||||
buttons:
|
||||
revoke: 撤销授权
|
||||
index:
|
||||
title: 已授权的应用
|
||||
application: 应用
|
||||
created_at: 授权时间
|
||||
date_format: "%Y-%m-%d %H:%M:%S"
|
||||
pre_authorization:
|
||||
status: 预授权
|
||||
errors:
|
||||
messages:
|
||||
invalid_request:
|
||||
unknown: 请求缺少必要的参数，或者参数值、格式不正确。
|
||||
missing_param: 'Missing required parameter: %{value}.'
|
||||
request_not_authorized: Request need to be authorized. Required parameter for authorizing request is missing or invalid.
|
||||
invalid_redirect_uri: 无效的登录回调地址。
|
||||
unauthorized_client: 未授权的应用，请求无法执行。
|
||||
access_denied: 资源所有者或服务器拒绝了请求。
|
||||
invalid_scope: 请求的权限范围无效、未知或格式不正确。
|
||||
invalid_code_challenge_method: The code challenge method must be plain or S256.
|
||||
server_error: 服务器异常，无法处理请求。
|
||||
temporarily_unavailable: 服务器维护中或负载过高，暂时无法处理请求。
|
||||
credential_flow_not_configured: 由于 Doorkeeper.configure.resource_owner_from_credentials 尚未配置，应用验证授权流程失败。
|
||||
resource_owner_authenticator_not_configured: 由于 Doorkeeper.configure.resource_owner_authenticator 尚未配置，查找资源所有者失败。
|
||||
admin_authenticator_not_configured: 由于 Doorkeeper.configure.admin_authenticator 尚未配置，禁止访问管理员面板。
|
||||
unsupported_response_type: 服务器不支持这种响应类型。
|
||||
unsupported_response_mode: The authorization server does not support this response mode.
|
||||
invalid_client: 由于应用信息未知、未提交认证信息或使用了不支持的认证方式，认证失败。
|
||||
invalid_grant: 授权方式无效、过期或已被撤销、与授权请求中的回调地址不一致，或使用了其他应用的回调地址。
|
||||
unsupported_grant_type: 服务器不支持此类型的授权方式。
|
||||
invalid_token:
|
||||
revoked: 访问令牌已被吊销
|
||||
expired: 访问令牌已过期
|
||||
unknown: 访问令牌无效
|
||||
revoke:
|
||||
unauthorized: You are not authorized to revoke this token
|
||||
forbidden_token:
|
||||
missing_scope: Access to this resource requires scope "%{oauth_scopes}".
|
||||
flash:
|
||||
applications:
|
||||
create:
|
||||
notice: 应用创建成功。
|
||||
destroy:
|
||||
notice: 应用删除成功。
|
||||
update:
|
||||
notice: 应用修改成功。
|
||||
authorized_applications:
|
||||
destroy:
|
||||
notice: 已成功撤销对此应用的授权。
|
||||
layouts:
|
||||
admin:
|
||||
title: Doorkeeper
|
||||
nav:
|
||||
oauth2_provider: OAuth2 提供商
|
||||
applications: 应用
|
||||
home: 首页
|
||||
application:
|
||||
title: 需要 OAuth 认证
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
Rails.application.routes.draw do
|
||||
|
||||
use_doorkeeper
|
||||
require 'sidekiq/web'
|
||||
require 'sidekiq/cron/web'
|
||||
require 'admin_constraint'
|
||||
|
|
@ -628,6 +629,14 @@ Rails.application.routes.draw do
|
|||
post :cancel
|
||||
end
|
||||
end
|
||||
resources :project_invite_links, only: [:index] do
|
||||
collection do
|
||||
get :current_link
|
||||
post :generate_link
|
||||
get :show_link
|
||||
post :redirect_link
|
||||
end
|
||||
end
|
||||
resources :webhooks, except: [:show, :new] do
|
||||
member do
|
||||
get :tasks
|
||||
|
|
|
|||
|
|
@ -0,0 +1,16 @@
|
|||
class CreateProjectInviteLinks < ActiveRecord::Migration[5.2]
|
||||
def change
|
||||
create_table :project_invite_links do |t|
|
||||
t.references :project
|
||||
t.references :user
|
||||
t.integer :role, default: 4
|
||||
t.boolean :is_apply, default: true
|
||||
t.string :sign
|
||||
t.datetime :expired_at
|
||||
|
||||
t.timestamps
|
||||
end
|
||||
|
||||
add_index :project_invite_links, :sign
|
||||
end
|
||||
end
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
class AddProjectInviteLinkToAppliedProjects < ActiveRecord::Migration[5.2]
|
||||
def change
|
||||
add_column :forge_applied_projects, :project_invite_link_id, :integer
|
||||
add_index :forge_applied_projects, :project_invite_link_id
|
||||
end
|
||||
end
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
class CreateDoorkeeperTables < ActiveRecord::Migration[5.2]
|
||||
def change
|
||||
create_table :oauth_applications do |t|
|
||||
t.string :name, null: false
|
||||
t.string :uid, null: false
|
||||
t.string :secret, null: false
|
||||
|
||||
# Remove `null: false` if you are planning to use grant flows
|
||||
# that doesn't require redirect URI to be used during authorization
|
||||
# like Client Credentials flow or Resource Owner Password.
|
||||
t.text :redirect_uri, null: false
|
||||
t.string :scopes, null: false, default: ''
|
||||
t.boolean :confidential, null: false, default: true
|
||||
t.timestamps null: false
|
||||
end
|
||||
|
||||
add_index :oauth_applications, :uid, unique: true
|
||||
|
||||
create_table :oauth_access_grants do |t|
|
||||
t.references :resource_owner, null: false
|
||||
t.references :application, null: false
|
||||
t.string :token, null: false
|
||||
t.integer :expires_in, null: false
|
||||
t.text :redirect_uri, null: false
|
||||
t.datetime :created_at, null: false
|
||||
t.datetime :revoked_at
|
||||
t.string :scopes, null: false, default: ''
|
||||
end
|
||||
|
||||
add_index :oauth_access_grants, :token, unique: true
|
||||
add_foreign_key(
|
||||
:oauth_access_grants,
|
||||
:oauth_applications,
|
||||
column: :application_id
|
||||
)
|
||||
|
||||
create_table :oauth_access_tokens do |t|
|
||||
t.references :resource_owner, index: true
|
||||
|
||||
# Remove `null: false` if you are planning to use Password
|
||||
# Credentials Grant flow that doesn't require an application.
|
||||
t.references :application, null: false
|
||||
|
||||
# If you use a custom token generator you may need to change this column
|
||||
# from string to text, so that it accepts tokens larger than 255
|
||||
# characters. More info on custom token generators in:
|
||||
# https://github.com/doorkeeper-gem/doorkeeper/tree/v3.0.0.rc1#custom-access-token-generator
|
||||
#
|
||||
# t.text :token, null: false
|
||||
t.string :token, null: false
|
||||
|
||||
t.string :refresh_token
|
||||
t.integer :expires_in
|
||||
t.datetime :revoked_at
|
||||
t.datetime :created_at, null: false
|
||||
t.string :scopes
|
||||
|
||||
# The authorization server MAY issue a new refresh token, in which case
|
||||
# *the client MUST discard the old refresh token* and replace it with the
|
||||
# new refresh token. The authorization server MAY revoke the old
|
||||
# refresh token after issuing a new refresh token to the client.
|
||||
# @see https://datatracker.ietf.org/doc/html/rfc6749#section-6
|
||||
#
|
||||
# Doorkeeper implementation: if there is a `previous_refresh_token` column,
|
||||
# refresh tokens will be revoked after a related access token is used.
|
||||
# If there is no `previous_refresh_token` column, previous tokens are
|
||||
# revoked as soon as a new access token is created.
|
||||
#
|
||||
# Comment out this line if you want refresh tokens to be instantly
|
||||
# revoked after use.
|
||||
t.string :previous_refresh_token, null: false, default: ""
|
||||
end
|
||||
|
||||
add_index :oauth_access_tokens, :token, unique: true
|
||||
add_index :oauth_access_tokens, :refresh_token, unique: true
|
||||
add_foreign_key(
|
||||
:oauth_access_tokens,
|
||||
:oauth_applications,
|
||||
column: :application_id
|
||||
)
|
||||
|
||||
# Uncomment below to ensure a valid reference to the resource owner's table
|
||||
# add_foreign_key :oauth_access_grants, <model>, column: :resource_owner_id
|
||||
# add_foreign_key :oauth_access_tokens, <model>, column: :resource_owner_id
|
||||
end
|
||||
end
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
class ChangeOauthAccessTokensTokenColumnLength < ActiveRecord::Migration[5.2]
|
||||
def change
|
||||
change_column :oauth_access_tokens, :token, :string, limit: 500
|
||||
end
|
||||
end
|
||||
|
|
@ -425,6 +425,18 @@
|
|||
<li>
|
||||
<a href="#projects" class="toc-h1 toc-link" data-title="Projects">Projects</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#b57112e753" class="toc-h2 toc-link" data-title="获取项目邀请链接（项目管理员）">获取项目邀请链接（项目管理员）</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#099c15c88b" class="toc-h2 toc-link" data-title="生成项目邀请链接（项目管理员）">生成项目邀请链接（项目管理员）</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#93da71d862" class="toc-h2 toc-link" data-title="获取邀请链接信息（被邀请用户）">获取邀请链接信息（被邀请用户）</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#1ba67175b6" class="toc-h2 toc-link" data-title="接受项目邀请链接（被邀请用户）">接受项目邀请链接（被邀请用户）</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#ac55469b06" class="toc-h2 toc-link" data-title="申请加入项目">申请加入项目</a>
|
||||
</li>
|
||||
|
|
@ -4410,7 +4422,572 @@ Success — a happy kitten is an authenticated kitten!
|
|||
</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>
|
||||
</span></code></pre></div><h1 id='projects'>Projects</h1><h2 id='b57112e753'>获取项目邀请链接（项目管理员）</h2>
|
||||
<p>当前登录（管理员）用户获取项目邀请链接的接口（第一次请求会默认生成role类型为developer和is_apply为true的链接）</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/kellect/project_invite_links/current_link.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/kellect/project_invite_links/current_link.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http'>HTTP 请求</h3>
|
||||
<p><code>GET /api/:owner/:repo/project_invite_links/current_link.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>role</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>项目权限，reporter: 报告者, developer: 开发者，manager：管理员</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_apply</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>boolean</td>
|
||||
<td>是否需要审核</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>role</td>
|
||||
<td>string</td>
|
||||
<td>邀请角色</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_apply</td>
|
||||
<td>boolean</td>
|
||||
<td>是否需要审核</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sign</td>
|
||||
<td>string</td>
|
||||
<td>邀请标识(放在链接后面即可)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>expired_at</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>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>
|
||||
</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">7</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="p">,</span><span class="w">
|
||||
</span><span class="nl">"is_apply"</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">"sign"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6b6b454843c291d4e52e60853cb8ad9f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"expired_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-06-23 10:08"</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">"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">474</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">"kellect"</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">"kellect"</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_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">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="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div><h2 id='099c15c88b'>生成项目邀请链接（项目管理员）</h2>
|
||||
<p>当前登录（管理员）用户生成的项目邀请链接，可选role和is_apply参数</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/yystopf/kellect/project_invite_links/generate_link.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/kellect/project_invite_links/generate_link.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-2'>HTTP 请求</h3>
|
||||
<p><code>POST /api/:owner/:repo/project_invite_links/generate_link.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>role</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>项目权限，reporter: 报告者, developer: 开发者，manager：管理员</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_apply</td>
|
||||
<td>是</td>
|
||||
<td></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">"role"</span><span class="p">:</span><span class="w"> </span><span class="s2">"developer"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"is_apply"</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><h3 id='b302a98fa6-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>role</td>
|
||||
<td>string</td>
|
||||
<td>邀请角色</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_apply</td>
|
||||
<td>boolean</td>
|
||||
<td>是否需要审核</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sign</td>
|
||||
<td>string</td>
|
||||
<td>邀请标识(放在链接后面即可)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>expired_at</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>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>
|
||||
</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">7</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="p">,</span><span class="w">
|
||||
</span><span class="nl">"is_apply"</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">"sign"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6b6b454843c291d4e52e60853cb8ad9f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"expired_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-06-23 10:08"</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">"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">474</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">"kellect"</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">"kellect"</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_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">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="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div><h2 id='93da71d862'>获取邀请链接信息（被邀请用户）</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/kellect/project_invite_links/show_link.json?invite_sign<span class="o">=</span>d612df03aad63760445c187bcf83f2e6
|
||||
</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/kellect/project_invite_links/show_link.json?invite_sign=d612df03aad63760445c187bcf83f2e6</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-3'>HTTP 请求</h3>
|
||||
<p><code>POST /api/:owner/:repo/project_invite_links/show_link.json?invite_sign=xxx</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>invite_sign</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td>string</td>
|
||||
<td>项目邀请链接的标识</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-3'>返回字段说明</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>role</td>
|
||||
<td>string</td>
|
||||
<td>邀请角色</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>is_apply</td>
|
||||
<td>boolean</td>
|
||||
<td>是否需要审核</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sign</td>
|
||||
<td>string</td>
|
||||
<td>邀请标识(放在链接后面即可)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>expired_at</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>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>
|
||||
</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">7</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="p">,</span><span class="w">
|
||||
</span><span class="nl">"is_apply"</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">"sign"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6b6b454843c291d4e52e60853cb8ad9f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="nl">"expired_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-06-23 10:08"</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">"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">474</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">"kellect"</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">"kellect"</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_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">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="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre></div><h2 id='1ba67175b6'>接受项目邀请链接（被邀请用户）</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/yystopf/kellect/project_invite_links/redirect_link.json?invite_sign<span class="o">=</span>d612df03aad63760445c187bcf83f2e6
|
||||
</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/kellect/project_invite_links/redirect_link.json?invite_sign=d612df03aad63760445c187bcf83f2e6</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-4'>HTTP 请求</h3>
|
||||
<p><code>POST /api/:owner/:repo/project_invite_links/redirect_link.json?invite_sign=xxx</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>invite_sign</td>
|
||||
<td>是</td>
|
||||
<td></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='ac55469b06'>申请加入项目</h2>
|
||||
<p>申请加入项目</p>
|
||||
|
||||
<blockquote>
|
||||
|
|
@ -4418,9 +4995,9 @@ Success — a happy kitten is an authenticated kitten!
|
|||
</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>
|
||||
</code></pre></div><h3 id='http-5'>HTTP 请求</h3>
|
||||
<p><code>POST /api/applied_projects.json</code></p>
|
||||
<h3 id='1f9ac54b15'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-5'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -4455,7 +5032,7 @@ Success — a happy kitten is an authenticated kitten!
|
|||
</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>
|
||||
</span></code></pre></div><h3 id='b302a98fa6-4'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -4596,9 +5173,9 @@ Success — a happy kitten is an authenticated kitten!
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-6'>HTTP 请求</h3>
|
||||
<p><code>GET api/projects</code></p>
|
||||
<h3 id='1f9ac54b15-2'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-6'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -4665,7 +5242,7 @@ http://localhost:3000/api/projects | jq
|
|||
<td>项目类型， 取值为：common、mirror; common:开源托管项目, mirror:开源镜像项目</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-2'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-5'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -4817,9 +5394,9 @@ Remember — a happy kitten is an authenticated kitten!
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-7'>HTTP 请求</h3>
|
||||
<p><code>GET api/projects/recommend</code></p>
|
||||
<h3 id='b302a98fa6-3'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-6'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -4953,9 +5530,9 @@ Remember — a happy kitten is an authenticated kitten!
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-8'>HTTP 请求</h3>
|
||||
<p><code>GET api/:owner/:repo/menu_list</code></p>
|
||||
<h3 id='1f9ac54b15-3'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-7'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -4980,7 +5557,7 @@ http://localhost:3000/api/yystopf/ceshi/menu_list | jq
|
|||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-4'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-7'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5021,9 +5598,9 @@ http://localhost:3000/api/yystopf/ceshi/menu_list | jq
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-9'>HTTP 请求</h3>
|
||||
<p><code>GET api/:owner/:repo/about</code></p>
|
||||
<h3 id='1f9ac54b15-4'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-8'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5048,7 +5625,7 @@ http://localhost:3000/api/jasder/forgeplus/about | jq
|
|||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-5'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-8'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5094,7 +5671,7 @@ Remember — a happy kitten is an authenticated kitten!
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-10'>HTTP 请求</h3>
|
||||
<p><code>GET /api/yystopf/ceshi/project_units</code></p>
|
||||
<h3 id='7447e4874e'>返回字段说明:</h3>
|
||||
<table><thead>
|
||||
|
|
@ -5137,9 +5714,9 @@ http://localhost:3000/api/yystopf/ceshi/project_units.json
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-11'>HTTP 请求</h3>
|
||||
<p><code>POST /api/yystopf/ceshi/project_units</code></p>
|
||||
<h3 id='1f9ac54b15-5'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-9'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5201,9 +5778,9 @@ http://localhost:3000/api/yystopf/ceshi/project_units.json
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-12'>HTTP 请求</h3>
|
||||
<p><code>POST api/projects</code></p>
|
||||
<h3 id='1f9ac54b15-6'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-10'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5277,7 +5854,7 @@ http://localhost:3000/api/projects.json
|
|||
<td>项目是否私有, true：为私有，false: 公开，默认为公开</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-6'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-9'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5319,9 +5896,9 @@ http://localhost:3000/api/projects.json
|
|||
<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>
|
||||
</code></pre></div><h3 id='http-13'>HTTP 请求</h3>
|
||||
<p><code>POST api/projects/migrate.json</code></p>
|
||||
<h3 id='1f9ac54b15-7'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-11'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5409,7 +5986,7 @@ http://localhost:3000/api/projects/migrate.json
|
|||
<td>项目是否私有, true：为私有，false: 非私有，默认为公开</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-7'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-10'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5444,9 +6021,9 @@ http://localhost:3000/api/projects/migrate.json
|
|||
</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>
|
||||
</code></pre></div><h3 id='http-14'>HTTP 请求</h3>
|
||||
<p><code>POST api/repositories/:id/sync_mirror.json</code></p>
|
||||
<h3 id='1f9ac54b15-8'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-12'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5464,7 +6041,7 @@ http://localhost:3000/api/projects/migrate.json
|
|||
<td>仓库id</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-8'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-11'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5499,9 +6076,9 @@ http://localhost:3000/api/projects/migrate.json
|
|||
</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>
|
||||
</code></pre></div><h3 id='http-15'>HTTP 请求</h3>
|
||||
<p><code>POST api/:owner/:repo/forks.json</code></p>
|
||||
<h3 id='1f9ac54b15-9'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-13'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5526,7 +6103,7 @@ http://localhost:3000/api/projects/migrate.json
|
|||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-9'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-12'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5562,9 +6139,9 @@ http://localhost:3000/api/projects/migrate.json
|
|||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> GET <span class="se">\</span>
|
||||
http://localhost:3000/api/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>
|
||||
</code></pre></div><h3 id='http-16'>HTTP 请求</h3>
|
||||
<p><code>GET api/:owner/:repo/applied_transfer_projects/organizations</code></p>
|
||||
<h3 id='1f9ac54b15-10'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-14'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5589,7 +6166,7 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat
|
|||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-10'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-13'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5656,9 +6233,9 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat
|
|||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> 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>
|
||||
</code></pre></div><h3 id='http-17'>HTTP 请求</h3>
|
||||
<p><code>POST /api/:owner/:repo/applied_transfer_projects.json</code></p>
|
||||
<h3 id='1f9ac54b15-11'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-15'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5690,7 +6267,7 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat
|
|||
<td>迁移对象标识</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-11'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-14'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5860,9 +6437,9 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat
|
|||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> 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>
|
||||
</code></pre></div><h3 id='http-18'>HTTP 请求</h3>
|
||||
<p><code>POST /api/:owner/:repo/applied_transfer_projects/cancel.json</code></p>
|
||||
<h3 id='1f9ac54b15-12'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-16'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -5887,7 +6464,7 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat
|
|||
<td>项目标识identifier</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h3 id='b302a98fa6-12'>返回字段说明</h3>
|
||||
<h3 id='b302a98fa6-15'>返回字段说明</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
@ -6057,9 +6634,9 @@ http://localhost:3000/api/ceshi1/ceshi_repo1/applied_transfer_projects/organizat
|
|||
</blockquote>
|
||||
<div class="highlight"><pre class="highlight shell tab-shell"><code>curl <span class="nt">-X</span> POST http://localhost:3000/api/ceshi1/ceshi_repo1/quit.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/quit.json</span><span class="dl">'</span><span class="p">)</span>
|
||||
</code></pre></div><h3 id='http-15'>HTTP 请求</h3>
|
||||
</code></pre></div><h3 id='http-19'>HTTP 请求</h3>
|
||||
<p><code>POST /api/:owner/:repo/quit.json</code></p>
|
||||
<h3 id='1f9ac54b15-13'>请求参数</h3>
|
||||
<h3 id='1f9ac54b15-17'>请求参数</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>参数</th>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
require 'rails_helper'
|
||||
|
||||
RSpec.describe ProjectInviteLink, type: :model do
|
||||
pending "add some examples to (or delete) #{__FILE__}"
|
||||
end
|
||||
Loading…
Reference in New Issue