tachybase_todo/packages/plugins/@nocobase/plugin-theme-editor/src/swagger/index.ts

224 lines
5.4 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 - Theme editor plugin',
},
components: {
schemas: {
Theme: {
type: 'object',
properties: {
id: {
type: 'integer',
},
config: {
type: 'object',
properties: {
name: {
type: 'string',
},
token: {
type: 'object',
additionalProperties: false,
},
},
required: ['name'],
additionalProperties: false,
},
optional: {
type: 'boolean',
},
isBuiltIn: {
type: 'boolean',
},
updatedAt: {
type: 'string',
format: 'date-time',
},
createdAt: {
type: 'string',
format: 'date-time',
},
},
required: ['id', 'config', 'optional', 'isBuiltIn'],
additionalProperties: false,
},
},
},
tags: [],
paths: {
'/themeConfig:list': {
get: {
tags: ['themeConfig'],
description: 'Get a list of themes',
parameters: [],
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
type: 'array',
items: {
$ref: '#/components/schemas/Theme',
},
},
},
},
},
'401': {
description: 'Unauthorized',
},
'404': {
description: 'Not Found',
},
},
},
},
'/themeConfig:create': {
post: {
tags: ['themeConfig'],
description: 'Create a new theme',
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
config: {
type: 'object',
properties: {
name: { type: 'string' },
token: {
type: 'object',
},
// 可以根据需要添加其他属性
},
required: ['name'],
additionalProperties: false,
},
optional: { type: 'boolean' },
isBuiltIn: { type: 'boolean' },
},
required: ['config'],
additionalProperties: false,
},
},
},
},
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Theme',
},
},
},
},
'400': {
description: 'Bad Request',
},
'401': {
description: 'Unauthorized',
},
},
},
},
'/themeConfig:update': {
post: {
tags: ['themeConfig'],
description: 'Update an existing theme',
parameters: [
{
name: 'id',
in: 'path',
description: 'ID of the theme to update',
required: true,
schema: {
type: 'string',
},
},
],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
properties: {
config: {
type: 'object',
properties: {
name: { type: 'string' },
token: {
type: 'object',
},
// 可以根据需要添加其他属性
},
additionalProperties: false,
},
optional: { type: 'boolean' },
isBuiltIn: { type: 'boolean' },
},
additionalProperties: false,
},
},
},
},
responses: {
'200': {
description: 'OK',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/Theme',
},
},
},
},
'400': {
description: 'Bad Request',
},
'401': {
description: 'Unauthorized',
},
'404': {
description: 'Not Found',
},
},
},
},
'/themeConfig:destroy': {
post: {
tags: ['themeConfig'],
description: 'Delete an existing theme',
parameters: [
{
name: 'id',
in: 'path',
description: 'ID of the theme to delete',
required: true,
schema: {
type: 'string',
},
},
],
responses: {
'204': {
description: 'No Content',
},
'401': {
description: 'Unauthorized',
},
'404': {
description: 'Not Found',
},
},
},
},
},
};