tachybase_todo/packages/plugins/@nocobase/plugin-ui-schema-storage/src/swagger/index.ts

334 lines
7.9 KiB
TypeScript
Raw Normal View History

feat: api documentation plugin (#2255) * feat: api doc plugin * fix: merge * chore: upgrade swagger ui to latest * feat: get paths from recourser * feat: configure security * feat: add models * feat: reimplement resource action * feat: support render schemas correctly * feat: support load swagger documentation * refactor: implement `SwaggerManager` * fix: re import * feat: update info * refactor: do not use the cache strategy for the time being * feat: support collection builtin actions * fix: incorrect tag * feat: support different swagger json for different plugins * feat: support load server package * feat: support visit from plugin center * feat: add schemas for mapConfiguration * feat: update * fix: update tags * feat: support only render plugin that has swagger content * refactor: use swagger-ui-react instead of swagger-ui-dist * fix: clean * fix: reset * refactor: update plugin place * fix: revert * fix: remove version * fix: type error * feat: swagger doc * refactor: improve apis * feat: add doc * feat: support destination cache * fix: avoid authorization override * fix: auth bug * feat: update documentation * fix: typo * feat: support json * fix: key * fix: update yarn.lock * feat: update swagger doc * feat: swagger doc * docs: add auth swagger files (#2341) * docs: add auth swagger files * fix: yarn.lock * fix: skip core * feat: swagger doc * docs: improve auth docs * fix(theme-editor): avoid crashing * feat(theme-editor): improve api doc * docs: add localization-management swagger * docs(plugin-workflow): add api doc (#2379) * fix: remove files * fix: aaa * fix: dist * fix: load swagger * feat: acl api doc (#2494) * chore: acl api doc * feat: ui schema api doc * feat: multi apps api doc * chore: ui schema doc * feat: collection api doc * chore: association api doc * chore: single association doc * feat: move action doc * chore: list parameters * feat: update swagger doc * chore: collectionIndex to first * fix: test error * fix: ref * chore: doc tags * chore: template * chore: doc with association options * chore: single association doc * chore: relation type * chore: filter single association params * chore: m2m api doc * chore: params * fix: 0.12.0-alpha.5 * fix: update yarn.lock * chore: data wrap --------- Co-authored-by: chenos <chenlinxh@gmail.com> Co-authored-by: YANG QIA <2013xile@gmail.com> Co-authored-by: Rain <958414905@qq.com> Co-authored-by: Junyi <mytharcher@users.noreply.github.com> Co-authored-by: ChengLei Shao <chareice@live.com>
2023-08-24 00:27:57 +08:00
export default {
openapi: '3.0.2',
info: {
title: 'NocoBase API - UI schema storage plugin',
},
tags: [],
paths: {
'/uiSchemas:getJsonSchema/{uid}': {
get: {
tags: ['uiSchemas'],
description: '',
parameters: [
{
$ref: '#/components/parameters/uid',
},
],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
},
},
'/uiSchemas:getProperties/{uid}': {
get: {
tags: ['uiSchemas'],
description: '获取ui schema的properties属性',
parameters: [
{
$ref: '#/components/parameters/uid',
},
],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
type: {
type: 'string',
},
properties: {
type: 'object',
additionalProperties: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
},
},
},
},
},
'/uiSchemas:insert': {
post: {
tags: ['uiSchemas'],
description: 'insert ui schema as root node',
requestBody: {
required: true,
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
},
},
'/uiSchemas:remove/{uid}': {
post: {
tags: ['uiSchemas'],
description: 'remove an ui schema node by uid',
parameters: [
{
$ref: '#/components/parameters/uid',
},
],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/uiSchemas:patch': {
post: {
tags: ['uiSchemas'],
description: 'update an ui schema node by an new ui schema',
requestBody: {
required: true,
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
},
},
'/uiSchemas:batchPatch': {
post: {
tags: ['uiSchemas'],
description: 'batch update ui schema nodes by an new ui schema item',
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'array',
items: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
responses: {
'200': {
description: 'OK',
},
},
},
},
'/uiSchemas:clearAncestor/{uid}': {
post: {
tags: ['uiSchemas'],
description: 'Removes all ancestors of a given node',
parameters: [
{
$ref: '#/components/parameters/uid',
},
],
responses: {
'200': {
description: 'OK',
},
},
},
},
'/uiSchemas:insertAdjacent/{uid}': {
post: {
tags: ['uiSchemas'],
description: 'insert a node adjacent to another node',
parameters: [
{
$ref: '#/components/parameters/uid',
},
{
name: 'position',
in: 'query',
required: true,
description: 'position',
schema: {
type: 'string',
enum: ['beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'],
},
},
],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
schema: {
$ref: '#/components/schemas/uiSchema',
},
wrap: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
},
responses: {
'200': {
description: 'OK',
},
},
},
},
'/uiSchemas:saveAsTemplate': {
post: {
tags: ['uiSchemas'],
description: 'save an ui schema as template',
parameters: [
{
name: 'filterByTk',
in: 'query',
required: true,
description: 'filterByTk',
schema: {
type: 'string',
},
},
],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
key: {
type: 'string',
},
collectionName: {
type: 'string',
},
componentName: {
type: 'string',
},
name: {
type: 'string',
description: "template's name",
},
resourceName: {
type: 'string',
description: "template's resourceName",
},
uid: {
type: 'string',
description: 'ui schema id',
},
},
},
},
},
},
responses: {
'200': {
description: 'OK',
},
},
},
},
},
components: {
parameters: {
uid: {
name: 'uid',
in: 'path',
required: true,
description: 'x-uid',
schema: {
type: 'string',
},
},
},
schemas: {
uiSchema: {
type: 'object',
properties: {
type: {
type: 'string',
example: 'void',
},
title: {
type: 'string',
example: '{{ t("Actions") }}',
description: "ui schema's title",
},
'x-uid': {
type: 'string',
example: 'ygdvvfnw3h8',
description: 'unique id of ui schema node',
},
'x-index': {
type: 'integer',
exmaple: 1,
description: "ui schema's order index",
},
'x-async': {
type: 'boolean',
example: false,
description: 'async or not',
},
name: {
type: 'string',
name: '2qakvs173rs',
description: "ui schema's name",
},
properties: {
type: 'object',
additionalProperties: {
$ref: '#/components/schemas/uiSchema',
},
},
},
},
},
},
};