From 1e0bedca86d09b3d4bc5c147af872505aeb70fc6 Mon Sep 17 00:00:00 2001 From: Dunqing Date: Thu, 24 Aug 2023 00:27:57 +0800 Subject: [PATCH] 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 Co-authored-by: YANG QIA <2013xile@gmail.com> Co-authored-by: Rain <958414905@qq.com> Co-authored-by: Junyi Co-authored-by: ChengLei Shao --- .prettierignore | 1 + packages/app/client/src/plugins/api-doc.ts | 1 + packages/core/actions/src/actions/add.ts | 15 +- packages/core/actions/src/utils.ts | 4 +- .../array-field-repository.ts | 8 +- .../belongs-to-many-repository.ts | 15 +- .../relation-repository/hasmany-repository.ts | 22 +- .../multiple-relation-repository.ts | 12 +- .../relation-repository.ts | 16 + .../single-relation-repository.ts | 3 +- packages/core/server/src/swagger/index.json | 1565 +++++++++++++++++ packages/core/utils/src/merge.ts | 3 +- packages/plugins/acl/src/swagger/index.ts | 373 ++++ packages/plugins/api-doc/.npmignore | 2 + packages/plugins/api-doc/LICENSE | 661 +++++++ packages/plugins/api-doc/README.md | 80 + packages/plugins/api-doc/README.zh-CN.md | 79 + packages/plugins/api-doc/client.d.ts | 2 + packages/plugins/api-doc/client.js | 1 + packages/plugins/api-doc/package.json | 23 + packages/plugins/api-doc/server.d.ts | 3 + packages/plugins/api-doc/server.js | 1 + .../plugins/api-doc/src/client/Document.tsx | 104 ++ packages/plugins/api-doc/src/client/index.tsx | 74 + packages/plugins/api-doc/src/index.ts | 1 + packages/plugins/api-doc/src/locale/en-US.ts | 1 + packages/plugins/api-doc/src/locale/index.ts | 16 + packages/plugins/api-doc/src/locale/zh-CN.ts | 5 + packages/plugins/api-doc/src/server/index.ts | 1 + packages/plugins/api-doc/src/server/server.ts | 48 + .../src/server/swagger/base-swagger.ts | 50 + .../collections/components/field-type-map.ts | 37 + .../swagger/collections/components/index.ts | 10 + .../collections/components/parameters.ts | 173 ++ .../swagger/collections/components/schemas.ts | 101 ++ .../src/server/swagger/collections/index.ts | 14 + .../collections/paths/associations/index.ts | 33 + .../associations/multiple-association.ts | 117 ++ .../paths/associations/single-association.ts | 92 + .../swagger/collections/paths/collection.ts | 340 ++++ .../server/swagger/collections/paths/index.ts | 23 + .../server/swagger/collections/tags/index.ts | 27 + .../api-doc/src/server/swagger/constants.ts | 10 + .../api-doc/src/server/swagger/helpers.ts | 109 ++ .../api-doc/src/server/swagger/index.ts | 225 +++ .../api-doc/src/server/swagger/loader.ts | 52 + .../api-doc/src/server/swagger/merge.ts | 10 + packages/plugins/api-doc/src/swagger.ts | 42 + .../plugins/api-keys/src/swagger/index.ts | 115 ++ packages/plugins/auth/src/swagger/index.ts | 731 ++++++++ .../china-region/src/swagger/index.json | 20 + .../plugins/client/src/swagger/index.json | 7 + .../collection-manager/src/swagger/index.json | 273 +++ .../data-visualization/src/swagger/index.ts | 7 + .../plugins/export/src/swagger/index.json | 21 + .../file-manager/src/swagger/index.json | 81 + .../plugins/iframe-block/src/swagger/index.ts | 7 + .../plugins/import/src/swagger/index.json | 33 + .../src/swagger/index.json | 156 ++ packages/plugins/map/src/swagger/index.ts | 78 + .../multi-app-manager/src/swagger/index.ts | 195 ++ packages/plugins/oidc/src/swagger/index.ts | 157 ++ packages/plugins/saml/src/swagger/index.ts | 142 ++ .../snapshot-field/src/swagger/index.ts | 7 + .../system-settings/src/swagger/index.json | 31 + .../src/client/components/ThemeCard.tsx | 2 +- .../changeAlgorithmFromStringToFunction.tsx | 2 +- .../plugins/theme-editor/src/swagger/index.ts | 223 +++ packages/plugins/theme-editor/src/types.ts | 2 +- .../src/server/actions/ui-schema-action.ts | 2 +- .../ui-schema-storage/src/swagger/index.ts | 333 ++++ packages/plugins/users/src/swagger/index.json | 117 ++ .../verification/src/swagger/index.json | 117 ++ .../workflow/src/client/nodes/index.tsx | 4 +- .../plugins/workflow/src/swagger/index.ts | 723 ++++++++ packages/presets/nocobase/package.json | 1 + packages/presets/nocobase/src/server/index.ts | 1 + yarn.lock | 96 +- 78 files changed, 8194 insertions(+), 95 deletions(-) create mode 100644 packages/app/client/src/plugins/api-doc.ts create mode 100644 packages/core/server/src/swagger/index.json create mode 100644 packages/plugins/acl/src/swagger/index.ts create mode 100644 packages/plugins/api-doc/.npmignore create mode 100644 packages/plugins/api-doc/LICENSE create mode 100644 packages/plugins/api-doc/README.md create mode 100644 packages/plugins/api-doc/README.zh-CN.md create mode 100644 packages/plugins/api-doc/client.d.ts create mode 100644 packages/plugins/api-doc/client.js create mode 100644 packages/plugins/api-doc/package.json create mode 100644 packages/plugins/api-doc/server.d.ts create mode 100644 packages/plugins/api-doc/server.js create mode 100644 packages/plugins/api-doc/src/client/Document.tsx create mode 100644 packages/plugins/api-doc/src/client/index.tsx create mode 100644 packages/plugins/api-doc/src/index.ts create mode 100644 packages/plugins/api-doc/src/locale/en-US.ts create mode 100644 packages/plugins/api-doc/src/locale/index.ts create mode 100644 packages/plugins/api-doc/src/locale/zh-CN.ts create mode 100644 packages/plugins/api-doc/src/server/index.ts create mode 100644 packages/plugins/api-doc/src/server/server.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/base-swagger.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/components/field-type-map.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/components/index.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/components/parameters.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/components/schemas.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/index.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/paths/associations/index.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/paths/associations/multiple-association.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/paths/associations/single-association.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/paths/collection.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/paths/index.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/collections/tags/index.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/constants.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/helpers.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/index.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/loader.ts create mode 100644 packages/plugins/api-doc/src/server/swagger/merge.ts create mode 100644 packages/plugins/api-doc/src/swagger.ts create mode 100644 packages/plugins/api-keys/src/swagger/index.ts create mode 100644 packages/plugins/auth/src/swagger/index.ts create mode 100644 packages/plugins/china-region/src/swagger/index.json create mode 100644 packages/plugins/client/src/swagger/index.json create mode 100644 packages/plugins/collection-manager/src/swagger/index.json create mode 100644 packages/plugins/data-visualization/src/swagger/index.ts create mode 100644 packages/plugins/export/src/swagger/index.json create mode 100644 packages/plugins/file-manager/src/swagger/index.json create mode 100644 packages/plugins/iframe-block/src/swagger/index.ts create mode 100644 packages/plugins/import/src/swagger/index.json create mode 100644 packages/plugins/localization-management/src/swagger/index.json create mode 100644 packages/plugins/map/src/swagger/index.ts create mode 100644 packages/plugins/multi-app-manager/src/swagger/index.ts create mode 100644 packages/plugins/oidc/src/swagger/index.ts create mode 100644 packages/plugins/saml/src/swagger/index.ts create mode 100644 packages/plugins/snapshot-field/src/swagger/index.ts create mode 100644 packages/plugins/system-settings/src/swagger/index.json create mode 100644 packages/plugins/theme-editor/src/swagger/index.ts create mode 100644 packages/plugins/ui-schema-storage/src/swagger/index.ts create mode 100644 packages/plugins/users/src/swagger/index.json create mode 100644 packages/plugins/verification/src/swagger/index.json create mode 100644 packages/plugins/workflow/src/swagger/index.ts diff --git a/.prettierignore b/.prettierignore index 869d9d40f..bda3aaf9a 100644 --- a/.prettierignore +++ b/.prettierignore @@ -15,3 +15,4 @@ packages/core/client/src/locale/* **/.dumi/tmp-production packages/core/cli/templates/plugin/src/client/*.tpl packages/app/client/src/.plugins +packages/**/locale/** diff --git a/packages/app/client/src/plugins/api-doc.ts b/packages/app/client/src/plugins/api-doc.ts new file mode 100644 index 000000000..1f5f77ef7 --- /dev/null +++ b/packages/app/client/src/plugins/api-doc.ts @@ -0,0 +1 @@ +export { default } from '@nocobase/plugin-api-doc/client'; diff --git a/packages/core/actions/src/actions/add.ts b/packages/core/actions/src/actions/add.ts index 0a768fb5b..122495c36 100644 --- a/packages/core/actions/src/actions/add.ts +++ b/packages/core/actions/src/actions/add.ts @@ -1,11 +1,11 @@ +import { + ArrayFieldRepository, + BelongsToManyRepository, + HasManyRepository, + MultipleRelationRepository, +} from '@nocobase/database'; import { Context } from '..'; import { getRepositoryFromParams } from '../utils'; -import { - BelongsToManyRepository, - MultipleRelationRepository, - HasManyRepository, - ArrayFieldRepository, -} from '@nocobase/database'; export async function add(ctx: Context, next) { const repository = getRepositoryFromParams(ctx); @@ -19,8 +19,9 @@ export async function add(ctx: Context, next) { ) { return await next(); } + const filterByTk = ctx.action.params.filterByTk || ctx.action.params.filterByTks || ctx.action.params.values; - await (repository).add(ctx.action.params.values); + await (repository).add(filterByTk); ctx.status = 200; diff --git a/packages/core/actions/src/utils.ts b/packages/core/actions/src/utils.ts index b0a1444da..6557c6f0c 100644 --- a/packages/core/actions/src/utils.ts +++ b/packages/core/actions/src/utils.ts @@ -28,7 +28,9 @@ export function RelationRepositoryActionBuilder(method: 'remove' | 'set') { return async function (ctx: Context, next) { const repository = getRepositoryFromParams(ctx); - await repository[method](ctx.action.params.values); + const filterByTk = ctx.action.params.filterByTk || ctx.action.params.filterByTks || ctx.action.params.values; + + await repository[method](filterByTk); ctx.status = 200; await next(); diff --git a/packages/core/database/src/field-repository/array-field-repository.ts b/packages/core/database/src/field-repository/array-field-repository.ts index 5aa048930..34cf59077 100644 --- a/packages/core/database/src/field-repository/array-field-repository.ts +++ b/packages/core/database/src/field-repository/array-field-repository.ts @@ -1,6 +1,6 @@ +import lodash from 'lodash'; import { Transactionable } from 'sequelize/types'; import { Collection } from '../collection'; -import lodash from 'lodash'; import { transactionWrapperBuilder } from '../decorators/transaction-decorator'; import { ArrayField } from '../fields'; @@ -9,7 +9,11 @@ const transaction = transactionWrapperBuilder(function () { }); export class ArrayFieldRepository { - constructor(protected collection: Collection, protected fieldName: string, protected targetValue: string | number) { + constructor( + protected collection: Collection, + protected fieldName: string, + protected targetValue: string | number, + ) { const field = collection.getField(fieldName); if (!(field instanceof ArrayField)) { throw new Error('Field must be of type Array'); diff --git a/packages/core/database/src/relation-repository/belongs-to-many-repository.ts b/packages/core/database/src/relation-repository/belongs-to-many-repository.ts index b73c70faa..6082d5ebb 100644 --- a/packages/core/database/src/relation-repository/belongs-to-many-repository.ts +++ b/packages/core/database/src/relation-repository/belongs-to-many-repository.ts @@ -133,23 +133,10 @@ export class BelongsToManyRepository extends MultipleRelationRepository { call: 'add' | 'set', options: TargetKey | TargetKey[] | PrimaryKeyWithThroughValues | PrimaryKeyWithThroughValues[] | AssociatedOptions, ) { - let handleKeys: TargetKey[] | PrimaryKeyWithThroughValues[]; + const handleKeys: TargetKey[] | PrimaryKeyWithThroughValues[] = this.convertTks(options) as any; const transaction = await this.getTransaction(options, false); - if (lodash.isPlainObject(options)) { - options = (options).tk || []; - } - - if (lodash.isString(options) || lodash.isNumber(options)) { - handleKeys = [options]; - } // if it is type primaryKeyWithThroughValues - else if (lodash.isArray(options) && options.length == 2 && lodash.isPlainObject(options[0][1])) { - handleKeys = [options]; - } else { - handleKeys = options; - } - const sourceModel = await this.getSourceModel(transaction); const setObj = (handleKeys).reduce((carry, item) => { diff --git a/packages/core/database/src/relation-repository/hasmany-repository.ts b/packages/core/database/src/relation-repository/hasmany-repository.ts index 21f95c9d9..cde1cc83b 100644 --- a/packages/core/database/src/relation-repository/hasmany-repository.ts +++ b/packages/core/database/src/relation-repository/hasmany-repository.ts @@ -1,6 +1,6 @@ import { omit } from 'lodash'; import { HasMany, Op } from 'sequelize'; -import { AggregateOptions, DestroyOptions, FindOptions, TargetKey, TK } from '../repository'; +import { AggregateOptions, DestroyOptions, FindOptions, TK, TargetKey } from '../repository'; import { AssociatedOptions, MultipleRelationRepository } from './multiple-relation-repository'; import { transaction } from './relation-repository'; export class HasManyRepository extends MultipleRelationRepository { @@ -89,20 +89,9 @@ export class HasManyRepository extends MultipleRelationRepository { return true; } - handleKeyOfAdd(options) { - let handleKeys; - - if (typeof options !== 'object' && !Array.isArray(options)) { - handleKeys = [options]; - } else { - handleKeys = options['pk']; - } - return handleKeys; - } - @transaction((args, transaction) => { return { - pk: args[0], + tk: args[0], transaction, }; }) @@ -111,23 +100,22 @@ export class HasManyRepository extends MultipleRelationRepository { const sourceModel = await this.getSourceModel(transaction); - await sourceModel[this.accessors().set](this.handleKeyOfAdd(options), { + await sourceModel[this.accessors().set](this.convertTks(options), { transaction, }); } @transaction((args, transaction) => { return { - pk: args[0], + tk: args[0], transaction, }; }) async add(options: TargetKey | TargetKey[] | AssociatedOptions): Promise { const transaction = await this.getTransaction(options); - const sourceModel = await this.getSourceModel(transaction); - await sourceModel[this.accessors().add](this.handleKeyOfAdd(options), { + await sourceModel[this.accessors().add](this.convertTks(options), { transaction, }); } diff --git a/packages/core/database/src/relation-repository/multiple-relation-repository.ts b/packages/core/database/src/relation-repository/multiple-relation-repository.ts index 4e598c31f..fc5e374b7 100644 --- a/packages/core/database/src/relation-repository/multiple-relation-repository.ts +++ b/packages/core/database/src/relation-repository/multiple-relation-repository.ts @@ -1,5 +1,5 @@ -import { HasOne, MultiAssociationAccessors, Sequelize, Transaction, Transactionable } from 'sequelize'; import lodash from 'lodash'; +import { HasOne, MultiAssociationAccessors, Sequelize, Transaction, Transactionable } from 'sequelize'; import injectTargetCollection from '../decorators/target-collection-decorator'; import { CommonFindOptions, @@ -8,8 +8,8 @@ import { Filter, FindOneOptions, FindOptions, - TargetKey, TK, + TargetKey, UpdateOptions, } from '../repository'; import { updateModelByValues } from '../update-associations'; @@ -113,14 +113,8 @@ export abstract class MultipleRelationRepository extends RelationRepository { }) async remove(options: TargetKey | TargetKey[] | AssociatedOptions): Promise { const transaction = await this.getTransaction(options); - let handleKeys = options['tk']; - - if (!Array.isArray(handleKeys)) { - handleKeys = [handleKeys]; - } - const sourceModel = await this.getSourceModel(transaction); - await sourceModel[this.accessors().removeMultiple](handleKeys, { + await sourceModel[this.accessors().removeMultiple](this.convertTks(options), { transaction, }); return; diff --git a/packages/core/database/src/relation-repository/relation-repository.ts b/packages/core/database/src/relation-repository/relation-repository.ts index d5ba61b95..a5e5f72ba 100644 --- a/packages/core/database/src/relation-repository/relation-repository.ts +++ b/packages/core/database/src/relation-repository/relation-repository.ts @@ -44,6 +44,22 @@ export abstract class RelationRepository { return this.db.getCollection(this.targetModel.name); } + convertTk(options: any) { + let tk = options; + if (typeof options === 'object' && options['tk']) { + tk = options['tk']; + } + return tk; + } + + convertTks(options: any) { + let tk = this.convertTk(options); + if (typeof tk === 'string') { + tk = tk.split(','); + } + return lodash.castArray(tk); + } + targetKey() { return this.associationField.targetKey; } diff --git a/packages/core/database/src/relation-repository/single-relation-repository.ts b/packages/core/database/src/relation-repository/single-relation-repository.ts index 4db3978d2..37ed99869 100644 --- a/packages/core/database/src/relation-repository/single-relation-repository.ts +++ b/packages/core/database/src/relation-repository/single-relation-repository.ts @@ -38,11 +38,10 @@ export abstract class SingleRelationRepository extends RelationRepository { }) async set(options: TargetKey | SetOption): Promise { const transaction = await this.getTransaction(options); - const handleKey = lodash.isPlainObject(options) ? (options).tk : options; const sourceModel = await this.getSourceModel(transaction); - return await sourceModel[this.accessors().set](handleKey, { + return await sourceModel[this.accessors().set](this.convertTk(options), { transaction, }); } diff --git a/packages/core/server/src/swagger/index.json b/packages/core/server/src/swagger/index.json new file mode 100644 index 000000000..c58b0dcf2 --- /dev/null +++ b/packages/core/server/src/swagger/index.json @@ -0,0 +1,1565 @@ +{ + "openapi": "3.0.2", + "info": { + "title": "NocoBase API - Core" + }, + "tags": [ + { "name": "$collection", "description": "Data table" }, + { "name": "$collection.$oneToOneAssociation", "description": "One to one relationship" }, + { "name": "$collection.$manyToOneAssociation", "description": "Many to one relationship" }, + { "name": "$collection.$oneToManyAssociation", "description": "One to many relationship" }, + { "name": "$collection.$manyToManyAssociation", "description": "Many to many relationship" }, + { "name": "app", "description": "app" }, + { "name": "pm", "description": "pm" } + ], + "components": { + "parameters": { + "collectionName": { + "required": true, + "name": "collectionName", + "in": "path", + "description": "Collection name", + "schema": { + "type": "string" + } + }, + "collectionIndex": { + "required": true, + "name": "collectionIndex", + "in": "path", + "description": "Collection index", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "oneToOneAssociation": { + "required": true, + "name": "oneToOneAssociation", + "in": "path", + "description": "Association name", + "schema": { + "type": "string" + } + }, + "manyToOneAssociation": { + "required": true, + "name": "manyToOneAssociation", + "in": "path", + "description": "Association name", + "schema": { + "type": "string" + } + }, + "oneToManyAssociation": { + "required": true, + "name": "oneToManyAssociation", + "in": "path", + "description": "Association name", + "schema": { + "type": "string" + } + }, + "manyToManyAssociation": { + "required": true, + "name": "manyToManyAssociation", + "in": "path", + "description": "Association name", + "schema": { + "type": "string" + } + }, + "page": { + "name": "page", + "in": "query", + "description": "page number", + "required": false, + "schema": { + "type": "integer" + } + }, + "pageSize": { + "name": "pageSize", + "in": "query", + "description": "page size", + "required": false, + "schema": { + "type": "integer" + } + }, + "filterByTk": { + "name": "filterByTk", + "in": "query", + "description": "filter by TK(default by ID)", + "schema": { + "type": "string" + } + }, + "filterByTks": { + "name": "filterByTks", + "in": "query", + "description": "filter by TKs(default by ID), example: `1,2,3`", + "schema": { + "type": "string" + } + }, + "filter": { + "name": "filter", + "in": "query", + "description": "filter items", + "schema": { + "type": "object" + } + }, + "sort": { + "name": "sort", + "in": "query", + "description": "sort items by fields, example: `-field1,-field2,field3`", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "example": ["-id", "createdAt"] + }, + { + "type": "string", + "example": "-id,createdAt" + } + ] + } + }, + "fields": { + "name": "fields", + "in": "query", + "description": "select fields, example: `field1,field2`", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "example": ["id", "createdAt"] + }, + { + "type": "string", + "example": "id,createdAt" + } + ] + } + }, + "except": { + "name": "except", + "in": "query", + "description": "except fields in results, example: `field1,field2`", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "example": ["id", "createdAt"] + }, + { + "type": "string", + "example": "id,createdAt" + } + ] + } + }, + "appends": { + "name": "appends", + "in": "query", + "description": "append associations in results, example: `assoc1,assoc2`", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "example": ["id", "createdAt"] + }, + { + "type": "string", + "example": "id,createdAt" + } + ] + } + }, + "whitelist": { + "name": "whitelist", + "in": "query", + "description": "whitelist for fields changes, example: `field1,field2`", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "example": ["id", "createdAt"] + }, + { + "type": "string", + "example": "id,createdAt" + } + ] + } + }, + "blacklist": { + "name": "blacklist", + "in": "query", + "description": "blacklist for fields changes, example: `field1,field2`", + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "type": "string" + }, + "example": ["id", "createdAt"] + }, + { + "type": "string", + "example": "id,createdAt" + } + ] + } + } + } + }, + "paths": { + "/{collectionName}:list": { + "get": { + "tags": ["$collection"], + "summary": "Returns a list of the collection", + "description": "A list of the collection", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/pageSize" + }, + { + "$ref": "#/components/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}:get": { + "get": { + "tags": ["$collection"], + "summary": "Returns a record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}:create": { + "post": { + "tags": ["$collection"], + "summary": "Create record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}:update": { + "post": { + "tags": ["$collection"], + "summary": "Update record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}:destroy": { + "post": { + "tags": ["$collection"], + "summary": "Delete record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}:move": { + "post": { + "tags": ["$collection"], + "summary": "Move record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "name": "sourceId", + "in": "query", + "description": "source id", + "schema": { + "type": "string" + } + }, + { + "name": "targetId", + "in": "query", + "description": "move target id", + "schema": { + "type": "string" + } + }, + { + "name": "method", + "in": "query", + "description": "move method, insertAfter or insertBefore", + "schema": { + "type": "string" + } + }, + { + "name": "sortField", + "in": "query", + "description": "sort field name, default is sort", + "schema": { + "type": "string" + } + }, + { + "name": "targetScope", + "in": "query", + "description": "move target scope", + "schema": { + "type": "string" + } + }, + { + "name": "sticky", + "in": "query", + "description": "sticky to top", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToOneAssociation}:get": { + "get": { + "tags": ["$collection.$oneToOneAssociation"], + "summary": "Returns the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToOneAssociation" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToOneAssociation}:create": { + "post": { + "tags": ["$collection.$oneToOneAssociation"], + "summary": "Create and associate a record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToOneAssociation" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToOneAssociation}:update": { + "post": { + "tags": ["$collection.$oneToOneAssociation"], + "summary": "Update the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToOneAssociation" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToOneAssociation}:destroy": { + "post": { + "tags": ["$collection.$oneToOneAssociation"], + "summary": "Delete and disassociate the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToOneAssociation" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToOneAssociation}:set": { + "post": { + "tags": ["$collection.$oneToOneAssociation"], + "summary": "Associate a record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToOneAssociation" + }, + { + "name": "filterByTk", + "in": "query", + "required": true, + "description": "filter by tk", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToOneAssociation}:remove": { + "post": { + "tags": ["$collection.$oneToOneAssociation"], + "summary": "Disassociate the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToOneAssociation" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToOneAssociation}:get": { + "get": { + "tags": ["$collection.$manyToOneAssociation"], + "summary": "Returns the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToOneAssociation" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToOneAssociation}:create": { + "post": { + "tags": ["$collection.$manyToOneAssociation"], + "summary": "Create and associate a record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToOneAssociation" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToOneAssociation}:update": { + "post": { + "tags": ["$collection.$manyToOneAssociation"], + "summary": "Update the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToOneAssociation" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToOneAssociation}:destroy": { + "post": { + "tags": ["$collection.$manyToOneAssociation"], + "summary": "Delete and disassociate the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToOneAssociation" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToOneAssociation}:set": { + "post": { + "tags": ["$collection.$manyToOneAssociation"], + "summary": "Associate a record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToOneAssociation" + }, + { + "name": "filterByTk", + "in": "query", + "required": true, + "description": "filter by tk", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToOneAssociation}:remove": { + "post": { + "tags": ["$collection.$manyToOneAssociation"], + "summary": "Disassociate the relationship record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToOneAssociation" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:list": { + "get": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Returns a list of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/pageSize" + }, + { + "$ref": "#/components/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:get": { + "get": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Returns a record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + }, + { + "$ref": "#/components/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:create": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Create and attach record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:update": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Update record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:destroy": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Delete and detach record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:move": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Move record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "name": "sourceId", + "in": "query", + "description": "source id", + "schema": { + "type": "string" + } + }, + { + "name": "targetId", + "in": "query", + "description": "move target id", + "schema": { + "type": "string" + } + }, + { + "name": "method", + "in": "query", + "description": "move method, insertAfter or insertBefore", + "schema": { + "type": "string" + } + }, + { + "name": "sortField", + "in": "query", + "description": "sort field name, default is sort", + "schema": { + "type": "string" + } + }, + { + "name": "targetScope", + "in": "query", + "description": "move target scope", + "schema": { + "type": "string" + } + }, + { + "name": "sticky", + "in": "query", + "description": "sticky to top", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:set": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Set or reset associations", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filterByTks" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:add": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Attach record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filterByTks" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{oneToManyAssociation}:remove": { + "post": { + "tags": ["$collection.$oneToManyAssociation"], + "summary": "Detach record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/oneToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filterByTks" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:list": { + "get": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Returns a list of the many-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/pageSize" + }, + { + "$ref": "#/components/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:get": { + "get": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Returns a record of the many-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/appends" + }, + { + "$ref": "#/components/parameters/except" + }, + { + "$ref": "#/components/parameters/sort" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:create": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Create and attach record of the many-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:update": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Update record of the many-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + }, + { + "$ref": "#/components/parameters/whitelist" + }, + { + "$ref": "#/components/parameters/blacklist" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:destroy": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Delete and detach record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:move": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Move record of the one-to-many relationship", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "name": "sourceId", + "in": "query", + "description": "source id", + "schema": { + "type": "string" + } + }, + { + "name": "targetId", + "in": "query", + "description": "move target id", + "schema": { + "type": "string" + } + }, + { + "name": "method", + "in": "query", + "description": "move method, insertAfter or insertBefore", + "schema": { + "type": "string" + } + }, + { + "name": "sortField", + "in": "query", + "description": "sort field name, default is sort", + "schema": { + "type": "string" + } + }, + { + "name": "targetScope", + "in": "query", + "description": "move target scope", + "schema": { + "type": "string" + } + }, + { + "name": "sticky", + "in": "query", + "description": "sticky to top", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:set": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Set or reset associations", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filterByTks" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:add": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Attach record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filterByTks" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:remove": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Detach record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + }, + { + "$ref": "#/components/parameters/filterByTks" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/{collectionName}/{collectionIndex}/{manyToManyAssociation}:toggle": { + "post": { + "tags": ["$collection.$manyToManyAssociation"], + "summary": "Attach or detach record", + "parameters": [ + { + "$ref": "#/components/parameters/collectionName" + }, + { + "$ref": "#/components/parameters/collectionIndex" + }, + { + "$ref": "#/components/parameters/manyToManyAssociation" + }, + { + "$ref": "#/components/parameters/filterByTk" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/app:getLang": { + "get": { + "tags": ["app"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/app:getInfo": { + "get": { + "tags": ["app"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/app:getPlugins": { + "get": { + "tags": ["app"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/app:restart": { + "post": { + "tags": ["app"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/app:clearCache": { + "post": { + "tags": ["app"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/pm:enable": { + "post": { + "tags": ["pm"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/pm:disable": { + "post": { + "tags": ["pm"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/pm:remove": { + "post": { + "tags": ["pm"], + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK" + } + } + } + } + } +} diff --git a/packages/core/utils/src/merge.ts b/packages/core/utils/src/merge.ts index 1fc8a3358..874e1a85c 100644 --- a/packages/core/utils/src/merge.ts +++ b/packages/core/utils/src/merge.ts @@ -2,8 +2,9 @@ import deepmerge from 'deepmerge'; const overwriteMerge = (destinationArray, sourceArray, options) => sourceArray; -export function merge(obj1: any, obj2: any) { +export function merge(obj1: any, obj2: any, opts?: any) { return deepmerge(obj1, obj2, { arrayMerge: overwriteMerge, + ...opts, }); } diff --git a/packages/plugins/acl/src/swagger/index.ts b/packages/plugins/acl/src/swagger/index.ts new file mode 100644 index 000000000..38874e155 --- /dev/null +++ b/packages/plugins/acl/src/swagger/index.ts @@ -0,0 +1,373 @@ +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: '更新时间', + }, + }, + }, + }, + }, +}; diff --git a/packages/plugins/api-doc/.npmignore b/packages/plugins/api-doc/.npmignore new file mode 100644 index 000000000..c593fe9df --- /dev/null +++ b/packages/plugins/api-doc/.npmignore @@ -0,0 +1,2 @@ +/node_modules +/src \ No newline at end of file diff --git a/packages/plugins/api-doc/LICENSE b/packages/plugins/api-doc/LICENSE new file mode 100644 index 000000000..0ad25db4b --- /dev/null +++ b/packages/plugins/api-doc/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/packages/plugins/api-doc/README.md b/packages/plugins/api-doc/README.md new file mode 100644 index 000000000..79befb22e --- /dev/null +++ b/packages/plugins/api-doc/README.md @@ -0,0 +1,80 @@ +# api-doc + +English | [中文](./README.zh-CN.md) + + +## Introduction + +This plugin is based on `swagger` to write documentation. + +## How to access the documentation + +1. The access address in the plugin center is `{domain}/admin/settings/api-doc/documentation` +2. The access address outside the plugin center is `{domain}/api-documentation` + +## How to write swagger documentation + +> The method in the plugin is the same + +1. `src/swagger.{ts,json}` +2. `src/swagger/index.{ts,json}` + +The file paths above can all be traversed to write documentation. Just export your written documentation by default. An example is shown below: + +```ts +export default { + info: { + title: 'NocoBase API - Api-doc plugin', + }, + tags: [], + paths: {}, + components: { + schemas: {} + } +}; +``` + +Usually, you only need to write **info.title**, **tags**, **paths**, and **components**. Other information such as **server** and **info** are merged into our **base-swagger**. + +Base swagger includes the following code: + +```ts +// base swagger +export default { + openapi: '3.0.3', + info: { + title: 'NocoBase API documentation', + description: '', + contact: { + url: 'https://github.com/nocobase/nocobase/issues', + }, + license: { + name: 'Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.', + url: 'https://github.com/nocobase/nocobase#license', + }, + }, + externalDocs: { + description: 'Find out more about NocoBase', + url: 'https://docs.nocobase.com/', + }, + components: { + securitySchemes: { + 'api-key': { + type: 'http', + scheme: 'bearer', + }, + }, + }, + security: [ + { + 'api-key': [], + }, + ], +}; +``` + +> Note that configurations that can only be obtained at runtime, such as the server and version fields, are not filled in the base-swagger. + +You can also override these defaults. When writing the swagger documentation for your plugin, you should consider whether your plugin's documentation can be accessed independently. + +For detailed swagger writing rules, please refer to the [official documentation](https://swagger.io/docs/specification/about/). diff --git a/packages/plugins/api-doc/README.zh-CN.md b/packages/plugins/api-doc/README.zh-CN.md new file mode 100644 index 000000000..4388ad4b8 --- /dev/null +++ b/packages/plugins/api-doc/README.zh-CN.md @@ -0,0 +1,79 @@ +# api-doc + +[English](./README.md) | 中文 + +## 简介 + +该插件基于 `swagger` 编写文档。 + +## 如何访问文档 + +1. 在插件中心访问地址是 `{domain}/admin/settings/api-doc/documentation` +2. 在插件中心外访问地址是 `{domain}/api-documentation` + +## 如何编写 swagger 文档 + +> 插件内方式一样 + +1. `src/swagger.{ts,json}` +2. `src/swagger/index.{ts,json}` + +上面的文件路径均可遍写文档，只需最后将您编写的文档默认导出即可，例子如下： + +```ts +export default { + info: { + title: 'NocoBase API - Auth plugin', + }, + tags: [], + paths: {}, + components: { + schemas: {} + } +}; +``` + +通常你只需要编写 **info.title**, **tags**, **paths**, **components** 即可其他内容如 **server**, **info** 的其他信息都合并我们的 **base-swagger**. + +base swagger 包含如下代码 +```ts +// base swagger +export default { + openapi: '3.0.3', + info: { + title: 'NocoBase API documentation', + description: '', + contact: { + url: 'https://github.com/nocobase/nocobase/issues', + }, + license: { + name: 'Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.', + url: 'https://github.com/nocobase/nocobase#license', + }, + }, + externalDocs: { + description: 'Find out more about NocoBase', + url: 'https://docs.nocobase.com/', + }, + components: { + securitySchemes: { + 'api-key': { + type: 'http', + scheme: 'bearer', + }, + }, + }, + security: [ + { + 'api-key': [], + }, + ], +}; + +``` + +> 注意：涉及到运行时才能获取的配置，并没有填写在 base-swagger 里，如 server, version 字段 + +这些默认的配置你同样也可以覆盖它，在你编写插件的 `swagger` 文档时，你需要视你的插件文档是独立的文档，可以被单独访问。 + +详细的 `swagger` 编写规则请参考[官方文档](https://swagger.io/docs/specification/about/) diff --git a/packages/plugins/api-doc/client.d.ts b/packages/plugins/api-doc/client.d.ts new file mode 100644 index 000000000..6c459cbac --- /dev/null +++ b/packages/plugins/api-doc/client.d.ts @@ -0,0 +1,2 @@ +export * from './dist/client'; +export { default } from './dist/client'; diff --git a/packages/plugins/api-doc/client.js b/packages/plugins/api-doc/client.js new file mode 100644 index 000000000..b6e3be70e --- /dev/null +++ b/packages/plugins/api-doc/client.js @@ -0,0 +1 @@ +module.exports = require('./dist/client/index.js'); diff --git a/packages/plugins/api-doc/package.json b/packages/plugins/api-doc/package.json new file mode 100644 index 000000000..1c27fd8a3 --- /dev/null +++ b/packages/plugins/api-doc/package.json @@ -0,0 +1,23 @@ +{ + "name": "@nocobase/plugin-api-doc", + "version": "0.12.0-alpha.5", + "displayName": "API documentation", + "displayName.zh-CN": "API 文档", + "description": "", + "license": "AGPL-3.0", + "main": "./dist/server/index.js", + "types": "./dist/server/index.d.ts", + "devDependencies": { + "swagger-ui-dist": "^5.3.1" + }, + "peerDependencies": { + "@nocobase/client": "0.x", + "@nocobase/database": "0.x", + "@nocobase/server": "0.x" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/nocobase/nocobase.git", + "directory": "packages/plugins/api-doc" + } +} diff --git a/packages/plugins/api-doc/server.d.ts b/packages/plugins/api-doc/server.d.ts new file mode 100644 index 000000000..0b9baefe6 --- /dev/null +++ b/packages/plugins/api-doc/server.d.ts @@ -0,0 +1,3 @@ +// @ts-nocheck +export * from './dist/server'; +export { default } from './dist/server'; diff --git a/packages/plugins/api-doc/server.js b/packages/plugins/api-doc/server.js new file mode 100644 index 000000000..972842039 --- /dev/null +++ b/packages/plugins/api-doc/server.js @@ -0,0 +1 @@ +module.exports = require('./dist/server/index.js'); diff --git a/packages/plugins/api-doc/src/client/Document.tsx b/packages/plugins/api-doc/src/client/Document.tsx new file mode 100644 index 000000000..985dfcc47 --- /dev/null +++ b/packages/plugins/api-doc/src/client/Document.tsx @@ -0,0 +1,104 @@ +import { css, useAPIClient, useRequest } from '@nocobase/client'; +import { Select, Space, Spin, Typography } from 'antd'; +import React, { useEffect, useRef, useState } from 'react'; +import { SwaggerUIBundle } from 'swagger-ui-dist'; +import 'swagger-ui-dist/swagger-ui.css'; +import { useTranslation } from '../locale'; + +const DESTINATION_URL_KEY = 'API_DOC:DESTINATION_URL_KEY'; +const getUrl = () => localStorage.getItem(DESTINATION_URL_KEY); + +const Documentation = () => { + const apiClient = useAPIClient(); + const { t } = useTranslation(); + const swaggerUIRef = useRef(); + + const { data: urls } = useRequest<{ data: { name: string; url: string }[] }>({ url: 'swagger:getUrls' }); + const requestInterceptor = (req) => { + if (!req.headers['Authorization']) { + req.headers['Authorization'] = `Bearer ${apiClient.auth.getToken()}`; + } + return req; + }; + + const [destination, onDestinationChange] = useState(getUrl()); + + useEffect(() => { + if (destination) { + localStorage.setItem(DESTINATION_URL_KEY, destination); + } + }, [destination]); + + useEffect(() => { + if (!urls?.data?.length) return; + + if (!destination || !urls.data.find((item) => item.url === getUrl())) { + onDestinationChange(urls.data[0].url); + } + }, [destination, urls]); + + useEffect(() => { + SwaggerUIBundle({ + requestInterceptor, + url: destination, + domNode: swaggerUIRef.current, + }); + }, [destination]); + + if (!destination) { + return ; + } + return ( + +
+
+ + {t('Select a definition')} + +