Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support(jsdoc): add swagger document to g2g-transfer.ts #9509

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

support(jsdoc): add swagger document to g2g-transfer.ts #9509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47b1458
support(jsdoc): add swagger document to g2g-transfer.ts
Dec 19, 2024
dc07698
support(jsdoc): add swagger document to g2g-transfer.ts
Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions apps/app/bin/swagger-jsdoc/definition-apiv3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ module.exports = {
in: 'cookie',
name: 'connect.sid',
},
transferHeaderAuth: {
type: 'apiKey',
in: 'header',
name: 'x-growi-transfer-key',
},
},
},
'x-tagGroups': [
Expand Down
232 changes: 231 additions & 1 deletion apps/app/src/server/routes/apiv3/g2g-transfer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,39 @@ const validator = {
],
};

/**
* @swagger
*
* components:
* schemas:
* GrowiInfo:
* type: object
* properties:
* version:
* type: string
* description: The version of the GROWI
* userUpperLimit:
* type: number
* description: The upper limit of the number of users
* fileUploadDisabled:
* type: boolean
* fileUploadTotalLimit:
* type: number
* description: The total limit of the file upload size
* attachmentInfo:
* type: object
* properties:
* type:
* type: string
* writable:
* type: boolean
* bucket:
* type: string
* customEndpoint:
* type: string
* uploadNamespace:
* type: string
*/
/*
* Routes
*/
Expand Down Expand Up @@ -130,13 +163,86 @@ module.exports = (crowi: Crowi): Router => {
const receiveRouter = express.Router();
const pushRouter = express.Router();

/**
* @swagger
*
* /g2g-transfer/files:
* get:
* summary: /g2g-transfer/files
* tags: [Export]
* security:
* - transferHeaderAuth: []
* responses:
* '200':
* description: Successfully got the list of files
* content:
* application/json:
* schema:
* type: object
* properties:
* files:
* type: array
* items:
* type: object
* properties:
* name:
* type: string
* description: The name of the file
* size:
* type: number
* description: The size of the file
*/
// eslint-disable-next-line max-len
receiveRouter.get('/files', validateTransferKey, async(req: Request, res: ApiV3Response) => {
const files = await crowi.fileUploadService.listFiles();
return res.apiv3({ files });
});

// Auto import
/**
* @swagger
*
* /g2g-transfer:
* post:
* summary: /g2g-transfer
* tags: [Export]
* security:
* - transferHeaderAuth: []
* requestBody:
* required: true
* content:
* multipart/form-data:
* schema:
* type: object
* properties:
* file:
* format: binary
* description: The zip file of the data to be transferred
* collections:
* type: array
* description: The list of MongoDB collections to be transferred
* items:
* type: string
* optionsMap:
* type: object
* description: The map of options for each collection
* operatorUserId:
* type: string
* description: The ID of the operator user
* uploadConfigs:
* type: object
* description: The map of upload configurations
* responses:
* '200':
* description: Successfully started to receive transfer data
* content:
* application/json:
* schema:
* type: object
* properties:
* message:
* type: string
* description: The message of the result
*/
// eslint-disable-next-line max-len
receiveRouter.post('/', uploads.single('transferDataZipFile'), validateTransferKey, async(req: Request & { file: any; }, res: ApiV3Response) => {
const { file } = req;
Expand Down Expand Up @@ -221,6 +327,40 @@ module.exports = (crowi: Crowi): Router => {
return res.apiv3({ message: 'Successfully started to receive transfer data.' });
});

/**
* @swagger
*
* /g2g-transfer/attachment:
* post:
* summary: /g2g-transfer/attachment
* tags: [Export]
* security:
* - transferHeaderAuth: []
* requestBody:
* required: true
* content:
* multipart/form-data:
* schema:
* type: object
* properties:
* file:
* format: binary
* description: The zip file of the data to be transferred
* attachmentMetadata:
* type: object
* description: Metadata of the attachment
* responses:
* '200':
* description:
* content:
* application/json:
* schema:
* type: object
* properties:
* message:
* type: string
* description: The message of the result
*/
// This endpoint uses multer's MemoryStorage since the received data should be persisted directly on attachment storage.
receiveRouter.post('/attachment', uploadsForAttachment.single('content'), validateTransferKey,
async(req: Request & { file: any; }, res: ApiV3Response) => {
Expand Down Expand Up @@ -250,6 +390,26 @@ module.exports = (crowi: Crowi): Router => {
return res.apiv3({ message: 'Successfully imported attached file.' });
});

/**
* @swagger
*
* /g2g-transfer/growi-info:
* get:
* summary: /g2g-transfer/growi-info
* tags: [Export]
* security:
* - transferHeaderAuth: []
* responses:
* '200':
* description:
* content:
* application/json:
* schema:
* type: object
* properties:
* growiInfo:
* $ref: '#/components/schemas/GrowiInfo'
*/
receiveRouter.get('/growi-info', validateTransferKey, async(req: Request, res: ApiV3Response) => {
let growiInfo: IDataGROWIInfo;
try {
Expand All @@ -268,6 +428,37 @@ module.exports = (crowi: Crowi): Router => {
return res.apiv3({ growiInfo });
});

/**
* @swagger
*
* /g2g-transfer/generate-key:
* post:
* summary: /g2g-transfer/generate-key
* tags: [Export]
* security:
* - api_key: []
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* appSiteUrl:
* type: string
* description: The URL of the GROWI
* responses:
* '200':
* description: Successfully generated transfer key
* content:
* application/json:
* schema:
* type: object
* properties:
* transferKey:
* type: string
* description: The transfer key
*/
// eslint-disable-next-line max-len
receiveRouter.post('/generate-key', accessTokenParser, adminRequiredIfInstalled, appSiteUrlRequiredIfNotInstalled, async(req: Request, res: ApiV3Response) => {
const appSiteUrl = req.body.appSiteUrl ?? crowi.configManager?.getConfig('crowi', 'app:siteUrl');
Expand All @@ -294,6 +485,45 @@ module.exports = (crowi: Crowi): Router => {
return res.apiv3({ transferKey: transferKeyString });
});

/**
* @swagger
*
* /g2g-transfer/transfer:
* post:
* summary: /g2g-transfer/transfer
* tags: [Export]
* security:
* - api_key: []
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* transferKey:
* type: string
* description: The transfer key
* collections:
* type: array
* description: The list of MongoDB collections to be transferred
* items:
* type: string
* optionsMap:
* type: object
* description: The map of options for each collection
* responses:
* '200':
* description: Successfully requested auto transfer
* content:
* application/json:
* schema:
* type: object
* properties:
* message:
* type: string
* description: The message of the result
*/
// eslint-disable-next-line max-len
pushRouter.post('/transfer', accessTokenParser, loginRequiredStrictly, adminRequired, validator.transfer, apiV3FormValidator, async(req: AuthorizedRequest, res: ApiV3Response) => {
const { transferKey, collections, optionsMap } = req.body;
Expand Down
Loading