tachybase_todo/packages/plugins/@nocobase/plugin-collection-manager/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

410 lines
9.4 KiB
TypeScript

export default {
openapi: '3.0.2',
info: {
title: 'NocoBase API - Collection manager plugin',
},
tags: [
{
name: 'collections',
},
{
name: 'collections.fields',
},
{
name: 'collectionCategories',
},
{
name: 'dbViews',
description: 'manager db views',
},
],
paths: {
'/collections:list': {
get: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections:get': {
get: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections:create': {
post: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections:update': {
post: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections:destroy': {
post: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections:move': {
post: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections:setFields': {
post: {
tags: ['collections'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections/{collectionName}/fields:get': {
get: {
tags: ['collections.fields'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections/{collectionName}/fields:list': {
get: {
tags: ['collections.fields'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections/{collectionName}/fields:create': {
post: {
tags: ['collections.fields'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections/{collectionName}/fields:update': {
post: {
tags: ['collections.fields'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections/{collectionName}/fields:destroy': {
post: {
tags: ['collections.fields'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collections/{collectionName}/fields:move': {
post: {
tags: ['collections.fields'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collectionCategories:list': {
post: {
tags: ['collectionCategories'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collectionCategories:get': {
post: {
tags: ['collectionCategories'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collectionCategories:create': {
post: {
tags: ['collectionCategories'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collectionCategories:update': {
post: {
tags: ['collectionCategories'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collectionCategories:destroy': {
post: {
tags: ['collectionCategories'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/collectionCategories:move': {
post: {
tags: ['collectionCategories'],
description: '',
parameters: [],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/dbViews:get': {
get: {
tags: ['dbViews'],
summary: 'get db view fields',
parameters: [
{
name: 'filterByTk',
in: 'query',
description: 'view name in database',
schema: {
type: 'string',
},
required: true,
example: 'posts_view',
},
{
name: 'schema',
in: 'query',
description: 'postgres schema of view in database',
schema: {
type: 'string',
},
},
],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
fields: {
type: 'object',
additionalProperties: {
type: 'object',
properties: {
name: { type: 'string', description: 'field name' },
type: { type: 'string', description: 'field type' },
source: { type: 'string', required: false, description: 'source field of view field' },
},
},
},
sources: {
type: 'array',
items: { type: 'string' },
},
},
},
},
},
},
},
},
},
},
},
'/dbViews:list': {
get: {
tags: ['dbViews'],
summary: 'list views that not connected to collections in database',
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
data: {
type: 'array',
items: {
type: 'object',
properties: {
name: { type: 'string', description: 'name of view' },
definition: { type: 'string', description: 'definition of view' },
schema: { type: 'string', description: 'schema of view' },
},
},
},
},
},
},
},
},
},
},
},
'/dbViews:query': {
get: {
tags: ['dbViews'],
summary: 'query db view data',
parameters: [
{
name: 'filterByTk',
in: 'query',
description: 'view name in database',
schema: {
type: 'string',
},
required: true,
example: 'posts_view',
},
{
name: 'schema',
in: 'query',
description: 'postgres schema of view in database',
schema: {
type: 'string',
},
},
{
name: 'page',
in: 'query',
description: 'page number',
schema: {
type: 'integer',
},
},
{
name: 'pageSize',
in: 'query',
description: 'page size',
schema: {
type: 'integer',
},
},
],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
data: {
type: 'array',
items: {
type: 'object',
description: 'row data of view',
additionalProperties: {
type: 'object',
description: "row data's field value",
},
},
},
},
},
},
},
},
},
},
},
},
};