* fix: perform load action on boot main app * feat: add dataType option in collection duplicator * chore: reset optional dumpable config * chore: dump command * chore: dump & restore command * chore: delay restore * fix: dump test * chore: restore command * chore: dump command action * chore: dumpable collection api * chore: client collection option * feat: backup& restore client * chore: content disposition header in dump response * chore: download backup field * feat: collection origin option * fix: test * chore: collection manager collection origin * chore: upload backup field * chore: upload restore file * chore: upload restore file * fix: test * chore: backup and restore support learn more * refactor: upload restore file * refactor: upload restore file * fix: test * fix: test * chore: dumpable collection with title * chore: pg only test * chore: test * fix: test * chore: test sleep * style: locale improve * refactor: download backup file * refactor: start restore * fix: restore key name * refactor: start restore * refactor: start restore * refactor: start restore * refactor: start restore * refactor: start restore * refactor: start restore * chore: unify duplicator option * fix: dump empty collection * chore: test * chore: test * style: style improve * refactor: locale improve * chore: dumpalbe collection orders * style: style improve * style: style improve * style: icon adjust * chore: nginx body size * chore: get file status * feat: run dump task * feat: download api * chore: backup files resourcer * feat: restore destroy api * chore: backup files resoucer * feat: list backup files action * chore: get collection meta from dumped file * fix: dump file name * fix: test * chore: backup and restore ui * chore: swagger api for backup & restore * chore: api doc * chore: api doc * chore: api doc * chore: backup and restore ui * chore: backup and restore ui * chore: backup and restore ui * chore: backup and restore ui * chore: backup and restore ui * fix: restore values * style: style improve * fix: download field respontype * fix: restore form local file * refactor: local improve * refactor: delete backup file * fix: in progress status * refactor: locale improve * refactor: locale improve * refactor: style improve * refactor: style improve * refactor: style improve * test: dump collection table attribute * chore: dump collection with table attributes * chore: test * chore: create new table in restore * fix: import error * chore: restore table from backup file * chore: sync collection after restore collections * fix: restore json data * style: style improve * chore: restore with fields * chore: test * fix: test * fix: test with underscored * style: style improve * fix: lock file state * chore: add test file * refactor: backup & restore plugin * fix: mysql test * chore: skip import view collection * chore: restore collection with inherits topo order * fix: import * style: style improve * fix: restore sequence fields * fix: themeConfig collection duplicator option * fix: restore with dialectOnly meta * fix: throw error * fix: restore * fix: import backup file created in postgres into mysql * fix: repeated items in inherits * chore: upgrade after restore * feat: check database env before restore * feat: handle autoincr val in postgres * chore: sqlite & mysql queryInterface * chore: test * fix: test * chore: test * fix: build * fix: pg test * fix: restore with date field * chore: theme-config collection * chore: chage import collections method to support collection origin * chore: fallback get autoincr value in mysql * fix: dataType normalize * chore: delay restore * chore: test * fix: build * feat: collectin onDump * feat: collection onDump interface * chore: dump with view collection * chore: sync in restore * refactor: locale improve * refactor: code improve * fix: test * fix: data sync * chore: rename backup & restore plugin * chore: skip test * style: style improve * style: style improve * style: style improve * style: style improve * chore: import version check * chore: backup file dir * chore: build * fix: bugs * fix: error * fix: pageSize * fix: import origin * fix: improve code * fix: remove namespace * chore: dump rules config * fix: dump custom collection * chore: version * fix: test * fix: test * fix: test * fix: test * chore: test * fix: load custom collection * fix: client * fix: translation * chore: code * fix: bug * fix: support shared option * fix: roles collection dumpRules * chore: test * fix: define collections * chore: collection group * fix: translation * fix: translation * fix: restore options * chore: restore command * chore: dump error * fix: too many open files --------- Co-authored-by: katherinehhh <katherine_15995@163.com> Co-authored-by: chenos <chenlinxh@gmail.com>
434 lines
11 KiB
TypeScript
434 lines
11 KiB
TypeScript
export default {
|
|
info: {
|
|
title: 'NocoBase API - Backup & Restore plugin',
|
|
},
|
|
tags: [],
|
|
paths: {
|
|
'/backupFiles:create': {
|
|
post: {
|
|
summary: 'Create a new backup file',
|
|
requestBody: {
|
|
required: true,
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
$ref: '#/components/schemas/DumpOptions',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
responses: {
|
|
'200': {
|
|
description: 'Dump successful',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
key: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'/backupFiles:list': {
|
|
get: {
|
|
summary: 'Get backup file list',
|
|
parameters: [
|
|
{
|
|
name: 'page',
|
|
in: 'query',
|
|
description: 'Page number of item to retrieve',
|
|
required: false,
|
|
schema: {
|
|
type: 'integer',
|
|
format: 'int32',
|
|
default: 1,
|
|
},
|
|
},
|
|
{
|
|
name: 'pageSize',
|
|
in: 'query',
|
|
description: 'Number of item to retrieve per page',
|
|
required: false,
|
|
schema: {
|
|
type: 'integer',
|
|
format: 'int32',
|
|
default: 10,
|
|
},
|
|
},
|
|
],
|
|
|
|
responses: {
|
|
'200': {
|
|
description: 'A paged array of backup statuses',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
data: {
|
|
type: 'array',
|
|
items: {
|
|
oneOf: [
|
|
{
|
|
$ref: '#/components/schemas/BackUpStatusOk',
|
|
},
|
|
{
|
|
$ref: '#/components/schemas/BackUpStatusDoing',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
meta: {
|
|
type: 'object',
|
|
properties: {
|
|
page: {
|
|
type: 'integer',
|
|
format: 'int32',
|
|
},
|
|
pageSize: {
|
|
type: 'integer',
|
|
format: 'int32',
|
|
},
|
|
count: {
|
|
type: 'integer',
|
|
format: 'int64',
|
|
},
|
|
totalPage: {
|
|
type: 'integer',
|
|
format: 'int32',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
required: ['data', 'meta'],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'/backupFiles:get': {
|
|
get: {
|
|
summary: 'Get backup file info',
|
|
parameters: [
|
|
{
|
|
name: 'filterByTk',
|
|
in: 'query',
|
|
required: true,
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
],
|
|
|
|
responses: {
|
|
'200': {
|
|
description: 'Status of the backup operation',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
oneOf: [
|
|
{
|
|
$ref: '#/components/schemas/BackUpStatusOk',
|
|
},
|
|
{
|
|
$ref: '#/components/schemas/BackUpStatusDoing',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'/backupFiles:download': {
|
|
get: {
|
|
summary: 'Download a backup file',
|
|
parameters: [
|
|
{
|
|
name: 'filterByTk',
|
|
in: 'query',
|
|
required: true,
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
],
|
|
responses: {
|
|
'200': {
|
|
description: 'Download successful',
|
|
content: {
|
|
'application/octet-stream': {
|
|
schema: {
|
|
type: 'string',
|
|
format: 'binary',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'/backupFiles:destroy': {
|
|
post: {
|
|
summary: 'Destroy a backup file',
|
|
parameters: [
|
|
{
|
|
name: 'filterByTk',
|
|
in: 'query',
|
|
required: true,
|
|
schema: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
],
|
|
responses: {
|
|
'200': {
|
|
description: 'Destroy successful',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
status: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'/backupFiles:upload': {
|
|
post: {
|
|
summary: 'Upload a backup file',
|
|
requestBody: {
|
|
required: true,
|
|
content: {
|
|
'multipart/form-data': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
file: {
|
|
type: 'string',
|
|
format: 'binary',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
|
|
responses: {
|
|
200: {
|
|
description: 'Upload successful',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
key: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
|
|
'/backupFiles:restore': {
|
|
post: {
|
|
summary: 'Restore from a backup file',
|
|
requestBody: {
|
|
required: true,
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
filterByTk: {
|
|
type: 'string',
|
|
},
|
|
dataTypes: {
|
|
type: 'array',
|
|
items: {
|
|
$ref: '#/components/schemas/DumpDataType',
|
|
},
|
|
uniqueItems: true,
|
|
},
|
|
key: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
oneOf: [
|
|
{
|
|
required: ['filterByTk', 'dataTypes'],
|
|
},
|
|
{
|
|
required: ['key', 'dataTypes'],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
|
|
responses: {
|
|
'200': {
|
|
description: 'Restore successful',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
status: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'/backupFiles:dumpableCollections': {
|
|
get: {
|
|
summary: 'Get dumpable collections',
|
|
responses: {
|
|
'200': {
|
|
description: 'A list of dumpable collections',
|
|
content: {
|
|
'application/json': {
|
|
schema: {
|
|
type: 'object',
|
|
properties: {
|
|
meta: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
name: {
|
|
type: 'string',
|
|
},
|
|
title: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
config: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
name: {
|
|
type: 'string',
|
|
},
|
|
title: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
business: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
name: {
|
|
type: 'string',
|
|
},
|
|
title: {
|
|
type: 'string',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
required: ['meta', 'config', 'business'],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
|
|
components: {
|
|
schemas: {
|
|
BackUpStatusOk: {
|
|
type: 'object',
|
|
properties: {
|
|
name: {
|
|
type: 'string',
|
|
},
|
|
createdAt: {
|
|
type: 'string',
|
|
format: 'date-time',
|
|
},
|
|
fileSize: {
|
|
type: 'string',
|
|
},
|
|
status: {
|
|
type: 'string',
|
|
enum: ['ok'],
|
|
},
|
|
},
|
|
required: ['name', 'createdAt', 'fileSize', 'status'],
|
|
},
|
|
|
|
BackUpStatusDoing: {
|
|
type: 'object',
|
|
properties: {
|
|
name: {
|
|
type: 'string',
|
|
},
|
|
inProgress: {
|
|
type: 'boolean',
|
|
enum: [true],
|
|
},
|
|
status: {
|
|
type: 'string',
|
|
enum: ['in_progress'],
|
|
},
|
|
},
|
|
required: ['name', 'inProgress', 'status'],
|
|
},
|
|
|
|
DumpDataType: {
|
|
type: 'string',
|
|
enum: ['meta', 'config', 'business'],
|
|
},
|
|
DumpOptions: {
|
|
type: 'object',
|
|
properties: {
|
|
dataTypes: {
|
|
type: 'array',
|
|
items: {
|
|
$ref: '#/components/schemas/DumpDataType',
|
|
},
|
|
uniqueItems: true,
|
|
},
|
|
},
|
|
required: ['dataTypes'],
|
|
},
|
|
},
|
|
},
|
|
};
|