tachybase_todo/packages/plugins/@nocobase/plugin-acl/src/swagger/index.ts
jack zhang 705b7449f0
feat: new plugin manager, supports adding plugins through UI (#2430)
* refactor: plugin manager page

* fix: bug

* feat: addByNpm api

* fix: improve the addByNpm

* feat: improve applicationPlugins:list api

* fix: re-download npm package when restart app

* fix: plugin delete api

* feat: plugin detail api

* feat: zipUrl add api

* fix: upload api bug

* fix: plugin detail info

* feat: upgrade api

* fix: upload api

* feat: handle plugin load error

* feat: support authToken

* feat: muti lang

* fix: build error

* fix: self review

* Update plugin-manager.ts

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: bugs

* fix: detail click and remove isOfficial

* fix: upgrade no refresh

* fix: file size and type check

* fix: bug

* fix: upgrade error

* fix: bug

* fix: bug

* fix: plugin card layout

* fix: handling exceptional cases

* fix: tgz file support

* fix: macos compress file

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: add upgrade npm type

* fix: bugs

* fix: bug

* fix: change plugins static expose url

* fix: api prefix

* fix: bug

* fix: add nginx `/static/plugin/` path

* fix: bugs and pr docker build no dts

* fix: bug

* fix: build tools bug

* fix: improve code

* fix: build bug

* feat: improve plugin info

* fix: ui bug

* fix: plugin document bug

* feat: improve code

* feat: improve code

* feat: process dev deps check

* feat: improve code

* feat: process.env.IS_DEV_CMD

* fix: do not delete the plugin package

* feat: plugin symlink

* fix: tsx watch --ignore=./storage/plugins/**

* fix: test error

* fix: improve code

* fix: improve code

* fix: emitStartedEvent

* fix: improve code

* fix: type error

* fix: test error

* test: console.log

* fix: createStoragePluginSymLink

* fix: clientStaticMiddleware rename to clientStaticUtils

* feat: build tools support plugins folder

* fix: 350px

* fix: error

* feat: client dev support plugin folder

* fix: clear cli options

* fix: typeError: Converting circular structure to JSON

* fix: plugin name

* chore: restart application after command

* feat: upgrade error & docs

* Update v14-changelog.md

* Update v14-changelog.md

* Update v14-changelog.md

* fix: gateway test

* refactor(plugin-workflow): add ready state for gracefully tearing down

* Revert "chore: restart application after command"

This reverts commit 5015274f8e4e06e506e15754b672330330e8c7f8.

* chore: stop application whe restart

* T 1218 change plugin folder (#2629)

* feat: change folder name

* feat: change `pm create` command

* feat:  revert plugin name change

* fix: delete samples

* feat: change plugins folder

* fix: pm create

* feat: update docs

* fix: link package error

* fix: docs

* fix: create command

* fix: pm add error

* fix: create  add build

* fix: pm creatre + add

* feat: add tar command

* fix: docs

* fix: bug

* fix: docs

---------

Co-authored-by: chenos <chenlinxh@gmail.com>

* feat: docs

* Update your-fisrt-plugin.md

* Update your-fisrt-plugin.md

* chore: application reload

* chore: test

* fix: pm add error

* chore: preset install skip exists plugin

* fix: createIfNotExists

---------

Co-authored-by: chenos <chenlinxh@gmail.com>
Co-authored-by: chareice <chareice@live.com>
Co-authored-by: Zhou <zhou.working@gmail.com>
Co-authored-by: mytharcher <mytharcher@gmail.com>
2023-09-12 22:39:23 +08:00

374 lines
9.3 KiB
TypeScript

export default {
openapi: '3.0.2',
info: {
title: 'NocoBase API - ACL plugin',
},
paths: {
'/roles:list': {
get: {
tags: ['roles'],
description: '',
parameters: [],
responses: {
200: {
description: 'ok',
content: {
'application/json': {
schema: {
type: 'array',
items: {
$ref: '#/components/schemas/role',
},
},
},
},
},
},
},
},
'/roles:get': {
get: {
tags: ['roles'],
description: '',
parameters: [
{
name: 'filterByTk',
in: 'query',
description: 'role name',
required: true,
schema: {
type: 'string',
},
},
],
responses: {
200: {
description: 'ok',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/role',
},
},
},
},
},
},
},
'/roles:create': {
post: {
tags: ['roles'],
description: '',
requestBody: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/role',
},
},
},
},
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/role',
},
},
},
},
},
},
},
'/roles:update': {
post: {
tags: ['roles'],
description: '',
parameters: [
{
name: 'filterByTk',
in: 'query',
description: 'role name',
required: true,
schema: {
type: 'string',
},
},
],
requestBody: {
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/role',
},
},
},
},
responses: {
200: {
description: 'ok',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/role',
},
},
},
},
},
},
},
'/roles:destroy': {
post: {
tags: ['roles'],
description: '',
parameters: [
{
name: 'filterByTk',
in: 'query',
description: 'role name',
required: true,
schema: {
type: 'string',
},
},
],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/roles:check': {
get: {
tags: ['roles'],
description: 'return current user role',
responses: {
200: {
description: 'ok',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/role',
},
},
},
},
},
},
},
'/roles:setDefaultRole': {
post: {
tags: ['roles'],
description: 'set default role for new user',
requestBody: {
content: {
'application/json': {
schema: {
type: 'object',
properties: {
roleName: {
type: 'string',
},
},
},
},
},
},
responses: {
'200': {
description: 'OK',
},
},
},
},
'/roles/{roleName}/collections:list': {
get: {
tags: ['roles.collections'],
description: 'list permissions of collections for role by roleName',
parameters: [
{
name: 'filterByTk',
in: 'query',
description: 'role name',
required: true,
schema: {
type: 'string',
},
},
],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'object',
properties: {
type: {
type: 'string',
description: 'collection',
},
name: {
type: 'string',
description: 'collection name',
},
collectionName: {
type: 'string',
description: 'collection name',
},
title: {
type: 'string',
description: 'collection title',
},
roleName: {
type: 'string',
description: 'role name',
},
usingConfig: {
type: 'string',
enum: ['resourceAction', 'strategy'],
description: 'resourceAction: 单独配置, strategy: 全局策略',
},
exists: {
type: 'boolean',
description: '是否存在单独配置的权限',
},
},
},
},
},
},
},
},
},
},
'/availableActions:list': {
get: {
tags: ['availableActions'],
description: 'available actions of resource in current system',
parameters: [],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'object',
properties: {
name: {
type: 'string',
description: 'Action名称',
},
displayName: {
type: 'string',
description: 'Action显示名称',
},
allowConfigureFields: {
type: 'boolean',
description: '是否允许配置字段',
},
onNewRecord: {
type: 'string',
description: '是否是新记录的Action',
},
type: {
type: 'string',
description: 'new-data 或者 old-data',
},
aliases: {
type: 'array',
items: {
type: 'string',
},
description: '别名',
},
},
},
},
},
},
},
},
},
},
},
components: {
schemas: {
role: {
type: 'object',
properties: {
title: {
type: 'string',
description: '角色名称',
},
name: {
type: 'string',
description: '角色标识',
},
description: {
type: 'string',
description: '角色描述',
},
hidden: {
type: 'boolean',
description: '是否隐藏',
},
default: {
type: 'boolean',
description: '是否默认',
},
allowConfigure: {
type: 'boolean',
description: '是否允许配置',
},
allowNewMenu: {
type: 'boolean',
description: '是否允许新建菜单',
},
snippets: {
type: 'array',
items: {
type: 'string',
},
description: '接口权限',
},
strategy: {
type: 'array',
description: '数据表权限策略',
items: {
type: 'object',
properties: {
actions: {
type: 'array',
items: {
type: 'string',
},
description: '操作',
},
},
},
},
createdAt: {
type: 'string',
format: 'date-time',
description: '创建时间',
},
updatedAt: {
type: 'string',
format: 'date-time',
description: '更新时间',
},
},
},
},
},
};