Просмотр исходного кода

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

Atsushi Nakatsugawa 1 год назад
Родитель
Сommit
dc07698eea
1 измененных файлов с 29 добавлено и 0 удалено
  1. 29 0
      apps/app/src/server/routes/apiv3/g2g-transfer.ts

+ 29 - 0
apps/app/src/server/routes/apiv3/g2g-transfer.ts

@@ -163,6 +163,35 @@ module.exports = (crowi: Crowi): Router => {
   const receiveRouter = express.Router();
   const receiveRouter = express.Router();
   const pushRouter = 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
   // eslint-disable-next-line max-len
   receiveRouter.get('/files', validateTransferKey, async(req: Request, res: ApiV3Response) => {
   receiveRouter.get('/files', validateTransferKey, async(req: Request, res: ApiV3Response) => {
     const files = await crowi.fileUploadService.listFiles();
     const files = await crowi.fileUploadService.listFiles();